Skip to content

Latest commit

 

History

History
69 lines (36 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

69 lines (36 loc) · 2.49 KB
Raw

Contributing to Node-bindgen

Thank you for contributing. No matter how large or small, contributions are always welcome. Before contributing, please read Code of Conduct

Table Of Contents

Assumptions

Ask a Question

Getting Started

Contributing

Assumptions

This project uses v5 of Node N-API. Please see following compatibility matrix.

Familiarity with

Currently, node-bindgen supports the following platforms:

  • Linux
  • MacOs
  • Windows

Ask a Question

Please open an Issue on GitHub with the label question.

Getting Started

  • Please follow README for installation instructions.

Contributing

Report a Bug

To report a bug, open an issue on GitHub with the label bug. Please ensure the issue has not already been reported.

Suggest an Enhancement

To suggest an enhancement, please create an issue on GitHub with the label enhancement.

Creating pull request

  • Fork the node-bindgen repository to your GitHub Account.

  • Create a branch, submit a PR when your changes are tested and ready for review

If you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.

Releasing New Versions

When a tagged branch with v* is pushed, a new release with that reference will be created and all crates in the workspace will be automatically published to crates.io. See the note below about version management.

Versioning

Version control is handled by the CI workflow using cargo cvm -x to check against the master or target branch. If the version has not been updated, the CI will error with a message of which crate(s) have outdated versions. If a version is outdated, the developer can run cargo cvm -f -s [major, minororpatch] to automatically bump the crate's version.

NOTE: If you run this in the workspace root, it will update all workspace crate versions. If this is not desired, run the command in the crate directory.

License

This project is licensed under the Apache license. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Fluvio by you, shall be licensed as Apache, without any additional terms or conditions.