diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4abc068f..f5049442 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,13 +2,15 @@ ## Communication -- Issues: [GitHub](https://github.com/authzed/spicedb-operator/issues) -- Email: [Google Groups](https://groups.google.com/g/authzed-oss) -- Discord: [Zanzibar Discord](https://authzed.com/discord) +- Bug Reports & Feature Requests: [GitHub Issues] +- Questions: [GitHub Discussions] or [Discord] -All communication must follow our [Code of Conduct]. +All communication in these forums abides by our [Code of Conduct]. +[GitHub Issues]: https://github.com/authzed/spicedb-operator/issues [Code of Conduct]: CODE-OF-CONDUCT.md +[Github Discussions]: https://github.com/orgs/authzed/discussions/new?category=q-a +[Discord]: https://authzed.com/discord ## Creating issues @@ -19,7 +21,7 @@ Before creating an issue, please check that an issue reporting the same problem To make the issue accurate and easy to understand, please try to create issues that are: - Unique -- do not duplicate existing bug report. - Deuplicate bug reports will be closed. + Duplicate bug reports will be closed. - Specific -- include as much details as possible: which version, what environment, what configuration, etc. - Reproducible -- include the steps to reproduce the problem. Some issues might be hard to reproduce, so please do your best to include the steps that might lead to the problem. @@ -35,35 +37,46 @@ Maintainers might ask for further information to resolve an issue. [filing-good-bugs]: http://fantasai.inkedblade.net/style/talks/filing-good-bugs/ +## Finding issues + +You can find issues by priority: [Urgent], [High], [Medium], [Low], [Maybe]. +There are also [good first issues]. + +[Urgent]: https://github.com/authzed/spicedb/labels/priority%2F0%20urgent +[High]: https://github.com/authzed/spicedb/labels/priority%2F1%20high +[Medium]: https://github.com/authzed/spicedb/labels/priority%2F2%20medium +[Low]: https://github.com/authzed/spicedb/labels/priority%2F3%20low +[Maybe]: https://github.com/authzed/spicedb/labels/priority%2F4%20maybe +[good first issues]: https://github.com/authzed/spicedb/labels/hint%2Fgood%20first%20issue + ## Contribution flow This is a rough outline of what a contributor's workflow looks like: - Create an issue - Fork the project -- Create a branch from where to base the contribution -- this is almost always `main` -- Push changes into a branch of your fork +- Create a [feature branch] +- Push changes to your branch - Submit a pull request - Respond to feedback from project maintainers +- Rebase to squash related and fixup commits +- Get LGTM from reviewer(s) +- Merge with a merge commit Creating new issues is one of the best ways to contribute. You have no obligation to offer a solution or code to fix an issue that you open. If you do decide to try and contribute something, please submit an issue first so that a discussion can occur to avoid any wasted efforts. -## Legal requirements +[feature branch]: https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow -In order to protect both you and ourselves, all commits will require an explicit sign-off that acknowledges the [DCO]. - -Sign-off commits end with the following line: +## Legal requirements -```git -Signed-off-by: Random J Developer -``` +In order to protect the project, all contributors are required to sign our [Contributor License Agreement][cla] before their contribution is accepted. -This can be done by using the `--signoff` (or `-s` for short) git flag to append this automatically to your commit message. -If you have already authored a commit that is missing the signed-off, you can amend or rebase your commits and force push them to GitHub. +The signing process has been automated by [CLA Assistant][cla-assistant] during the Pull Request review process and only requires responding with a comment acknowledging the agreement. -[DCO]: /DCO +[cla]: https://github.com/authzed/cla/blob/main/v1/icla.md +[cla-assistant]: https://github.com/cla-assistant/cla-assistant ## Common tasks