Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 2.92 KB

How to Contribute

First of all, please keep in mind that multiple types of contributions are possible, apart from contributing code:

  • Sharing feedback from using this project (e.g. in issues)
  • Use cases, feature requests: Roadmap influence
  • Community Support, bug fixes, forum posts: Help to be helped
  • Documentation: Everyone needs good docs, Code is a moving target. If you find something wrong in the docs, fix it!!
  • Test cases (including Perf, load, security, unit tests, interop, ...) / CI

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability. Please contact us privately instead.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one, filling-in all the necessary information in the Issue template.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Do include the relevant issue number.

Do you intend to add a new feature or change an existing one?

  • Suggest your change by opening a GitHub issue first, before writing any code.

  • Please think twice about starting to work on code before having collected positive feedback about the change. Maintainers may have already decided against accepting such contributions, so your work may not be incorporated.

Is there any other requirement to open a PR?

We enforce all the commits to be signed with GPG before merging the PR to master. GPG is a form of encryption and it is used to verify the identity of the committer so other people can trust that the changes come from a trusted source.

To do so, you only need to follow these steps:

  1. Check if you already have existing GPG keys in your local computer following this guide.
  2. If you don't have any, generate a new GPG key following this guide.
  3. Add the GPG key to your GitHub account following this guide.
  4. Tell Git about your signing key following this guide.
  5. Sign your commits with the GPG key following this guide.

Do you have questions about the source code?

  • Ask any question by raising an issue. Maintainers could always use more help, so they'll be happy to assist you along, no matter how silly you might your question sounds.

Thanks for reading this far!!

With ❤️, The 3scale team