Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (34 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 2.83 KB

Contributing

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Any unacceptable behavior should be reported to kroxylicious-admins@redhat.com.

How can I contribute

You can contribute by:

  • Reporting any issues you find using Kroxylicious
  • Fixing issues by opening Pull Requests
  • Reviewing Pull Requests opened by others.
  • Improving documentation
  • Talking about Kroxylicious

All bugs, tasks or enhancements are tracked as GitHub issues. Issues which might be a good start for new contributors are marked with the “good-start” label.

Finding an Issue

We have issues labelled good first issue for new contributors and help wanted issues suitable for any contributor.

Sometimes there won’t be any issues with these labels. That’s ok! There is likely still something for you to work on. If you want to contribute but you don’t know where to start or can't find a suitable issue, you can come chat to us.

Once you see an issue that you'd like to work on, please post a comment saying that you want to work on it. Something like "I want to work on this" is fine. If later you need to change your mind, for whatever reason, that's fine too. Just post another message so others know its free.

DCO Signoff

The project requires that all commits are signed-off, indicating that you certify the changes with the Developer Certificate of Origin (DCO).

This can be done using git commit -s for each commit in your pull request. Alternatively, to signoff a bunch of commits you can use git rebase --signoff _your-branch_.

PR Review

All changes which are to be committed in project source control must be reviewed by at least one Committer before being merged. If the change is being authored by someone who is a Committer, that change must be reviewed by at least one other Committer before being merged. The GitHub teams @kroxylicious/code-reviewers and @kroxylicious/doc-reviewers can be used to request a PR review from contributors.

If you're willing to provide code and/or reviews to others then let one of the project managers know and we can add you to the relevant GitHub team.

I just have a question

If you encounter any issues while using Kroxylicious, you can get help using: