2020-02-01 11:05:43 +00:00
# Contributing
2022-06-15 07:51:47 +00:00
Anybody willing to contribute to the project either with code, documentation, security reviews or whatever, are very
welcome to create or review pull requests and take part in discussions in any of our public
2022-12-07 09:43:02 +00:00
[chat rooms ](README.md#contact-options ).
2020-02-01 11:05:43 +00:00
2021-01-30 08:29:07 +00:00
It's also possible to contribute financially in order to support the community.
2020-02-01 11:05:43 +00:00
2021-01-30 08:29:07 +00:00
Don't hesitate to come help us improve Authelia! See you soon!
## Bug Reports and Feature Requests
2022-12-19 04:04:02 +00:00
If you've found a **bug** or have a **feature request** then please create a
[bug report ](https://www.authelia.com/l/bug ) or [feature request ](https://www.authelia.com/l/fr ) respectively in this
repository (but search first in case a similar issue already exists).
2021-01-30 08:29:07 +00:00
## Code
If you would like to fix a bug or implement a feature, please fork the repository and create a Pull Request.
2022-06-15 07:51:47 +00:00
More information on getting set up locally can be found in the
2023-03-19 06:29:12 +00:00
[Development Contribution ](https://www.authelia.com/contributing/development/introduction/ ) documentation, in addition
the [Contribution Guidelines ](https://www.authelia.com/contributing/guidelines/introduction/ ) documentation includes
several contribution guidelines.
2021-01-30 08:29:07 +00:00
2022-06-15 07:51:47 +00:00
Before you start any Pull Request, it's recommended that you create an issue to discuss first if you have any doubts
about requirement or implementation. That way you can be sure that the maintainer(s) agree on what to change and how,
and you can hopefully get a quick merge afterwards. Also, let the maintainers know that you plan to work on a particular
issue so that no one else starts any duplicate work.
2021-01-30 08:29:07 +00:00
2022-12-19 04:04:02 +00:00
Pull Requests can only be merged once all status checks are green, which means `authelia-scripts --log-level debug ci`
passes, and coverage does not regress.
2021-01-30 08:29:07 +00:00
2023-04-26 02:48:15 +00:00
### Sign the Developer Certificate of Origin
2021-01-30 08:29:07 +00:00
2023-04-26 02:48:15 +00:00
Please ensure you complete the [Developer Certificate of Origin] sign off for all commits. More information can be found
in the [Developer Certificate of Origin] documentation.
### Do not force push to your pull request branch
Please do not force push to your PR's branch after you have created your PR especially when a maintainer has either
performed a review or has indicated they are performing a review, as doing so makes it harder to review your commits
accurately. PRs will always be squashed by us when we merge your work. Commit as many times as you need in your
2022-12-19 04:04:02 +00:00
pull request branch.
2021-01-30 08:29:07 +00:00
2023-04-26 02:48:15 +00:00
A few exceptions exist to this rule and are as follows:
- Making adjustments to the commit message i.e. for the following reasons:
- To comply with the [Developer Certificate of Origin] sign off requirement
- To comply with the other [Commit Message] guidelines
- To rebase your changes off of master or another branch
[Developer Certificate of Origin]: https://www.authelia.com/contributing/guidelines/commit-message/#developer-certificate-of-origin
[Commit Message]: https://www.authelia.com/contributing/guidelines/commit-message/
2021-01-30 08:29:07 +00:00
## Re-requesting a review
Please do not ping your reviewer(s) by mentioning them in a new comment.
Instead, use the re-request review functionality.
Read more about this in the [GitHub docs, Re-requesting a review ](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request#re-requesting-a-review ).
## Collaboration with maintainers
2022-06-15 07:51:47 +00:00
Sometimes the codebase can be a challenge to navigate, especially for a first-time contributor. We don't want you
2021-07-30 04:19:17 +00:00
spending an hour trying to work out something that would take us only a minute to explain.
2021-01-30 08:29:07 +00:00
2022-12-07 09:43:02 +00:00
If you'd like some help getting started we have several [contact options ](README.md#contact-options ) available.
