Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (53 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

73 lines (53 loc) · 2.81 KB

Contributing

Review the following guidelines for submitting questions, issues, or changes to this repository. One of the most impactful changes would be examples and documentation.

Coding Style

Please run golangci-lint run and fix any issues found.

Issues and Questions

If you encounter an issue, have a question or want to suggest an enhancement, you are welcome to submit a request. Before that, please search for similar issues. It's possible somebody has encountered this issue already.

Pull Requests

If you want to contribute to the repository, here's a quick guide:

  1. Fork the repository
  2. Develop and test your code changes:
    • Follow the coding style as documented above.
    • Please add one or more tests to validate your changes.
  3. Make sure everything builds/tests cleanly.
  4. Commit your changes. Add a descriptive prefix to commits. The list allowed is as below:
    • feat for features
    • fix for bug fixes
    • revert for reversing a change
    • docs for documentation and examples
    • style for formatting and other related changes
    • refactor is self-explanatory
    • test for test case changes
    • build for build changes
    • autogen for any auto-generated code or documentation
    • security for any security fixes and enhancements
    • ci for changes to continuous integration
    • chore is self-explanatory
  5. Push to your fork and submit a pull request to the main branch. Include the tests executed in the pull request.

Generating documentation

WIP

Additional Resources

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.