Skip to content

Commit c3314bc

Browse files
committed
Add CONTRIBUTING.md
1 parent 51a0afa commit c3314bc

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing
2+
3+
This package is open to contributions 👏
4+
5+
To contribute, please follow these steps:
6+
7+
1. Create an issue explaining what you'd like to fix or add. This way, we can approve and discuss the
8+
solution before any time is spent on developing it.
9+
2. Fork the upstream repository into a personal account.
10+
3. Install [poetry](https://python-poetry.org/), and install all dependencies using ``poetry install``
11+
4. Activate the environment by running ``poetry shell``
12+
5. Install [pre-commit](https://pre-commit.com/) (for project linting) by running ``pre-commit install``
13+
6. Create a new branch for your changes, and make sure to add tests!
14+
7. Push the topic branch to your personal fork
15+
8. Run `pre-commit run --all-files` locally to ensure proper linting
16+
9. Create a pull request to the Intility repository with a detailed summary of your changes and what motivated the change
17+
18+
If you need a more detailed walk through, please see this
19+
[issue comment](https://github.com/Intility/fastapi-azure-auth/issues/49#issuecomment-1056962282).

0 commit comments

Comments
 (0)