Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 1.75 KB

Contributing

As a contributor, you should agree that:

  • The project maintainers can adjust the open-source agreement to be more strict or relaxed as deemed necessary.
  • Your contributed code may be used for commercial purposes, including but not limited to cloud business operations.

Create pull request

PRs are always welcome, even if they only contain small fixes like typos or a few lines of code. If there will be a significant effort, please document it as an issue and get a discussion going before starting to work on it.

Please submit a PR broken down into small changes bit by bit. A PR consisting of a lot of features and code changes may be hard to review. It is recommended to submit PRs in an incremental fashion.

Note: If you split your pull request into small changes, please make sure any of the changes that go to main will not break anything. Otherwise, they cannot be merged until the feature is complete.

Report issues

It is a great way to contribute by reporting an issue. Well-written and complete bug reports are always welcome. Please open an issue and follow the template to fill in required information.

Before opening any issue, please look up the existing issues to avoid submitting a duplicate.

If you find a match, you can subscribe to it to get notified on updates. If you have additional helpful information about the issue, please leave a comment.

When reporting issues, always include:

  • Which version you are using
  • Steps to reproduce the issue
  • Snapshots or log files if needed

Because the issues are open to the public, when submitting files, be sure to remove any sensitive information, such as user names, passwords, IP addresses, and company names. You can replace those parts with REDACTED or other strings like ****.