RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
authelia/CONTRIBUTING.md

44 lines
2.4 KiB
Markdown
Raw Normal View History

[MISC] Add a CONTRIBUTING.md to the project. (#604)
2020-02-01 11:05:43 +00:00
# Contributing
docs: update and unify contact options (#2213) This updates and unifies the contact options so it is easier to maintain. All contact options now link back to one of two locations, and both of these locations are a copy and paste for the most part. Co-authored-by: Amir Zarrinkafsh <nightah@me.com>
2021-07-30 04:19:17 +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
[chat rooms](./README.md#contact-options).
[MISC] Add a CONTRIBUTING.md to the project. (#604)
2020-02-01 11:05:43 +00:00
docs: update contribution guidelines (#1666) * docs: update contribution guidelines * add release commit message type * update none/empty scope definition * add go mod tidy post update option
2021-01-30 08:29:07 +00:00
It's also possible to contribute financially in order to support the community.
[MISC] Add a CONTRIBUTING.md to the project. (#604)
2020-02-01 11:05:43 +00:00
docs: update contribution guidelines (#1666) * docs: update contribution guidelines * add release commit message type * update none/empty scope definition * add go mod tidy post update option
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
If you've found a **bug** or have a **feature request** then please create an issue in this repository (but search first in case a similar issue already exists).
## Code
If you would like to fix a bug or implement a feature, please fork the repository and create a Pull Request.
More information on getting set up locally can be found [here](https://www.authelia.com/docs/contributing/).
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.
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.
## 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, as doing so makes it harder for us to review your work.
PRs will always be squashed by us when we merge your work.
Commit as many times as you need in your pull request branch.
## 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
docs: update and unify contact options (#2213) This updates and unifies the contact options so it is easier to maintain. All contact options now link back to one of two locations, and both of these locations are a copy and paste for the most part. Co-authored-by: Amir Zarrinkafsh <nightah@me.com>
2021-07-30 04:19:17 +00:00
Sometimes the codebase can be a challenge to navigate, especially for a first-time contributor. We don't want you
spending an hour trying to work out something that would take us only a minute to explain.
docs: update contribution guidelines (#1666) * docs: update contribution guidelines * add release commit message type * update none/empty scope definition * add go mod tidy post update option
2021-01-30 08:29:07 +00:00
docs: update and unify contact options (#2213) This updates and unifies the contact options so it is easier to maintain. All contact options now link back to one of two locations, and both of these locations are a copy and paste for the most part. Co-authored-by: Amir Zarrinkafsh <nightah@me.com>
2021-07-30 04:19:17 +00:00
If you'd like some help getting started we have several [contact options](./README.md#contact-options) available.