Skip to content

Commit 1f8b722

Browse files
committed
Update contributing guide
1 parent 19170f5 commit 1f8b722

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,28 @@ It also contains a Django example project to play around with the features.
2424
git clone https://github.com/openradx/adit-radis-shared.git
2525
cd adit-radis-shared
2626
uv sync
27-
uv run ./cli.py compose-up
27+
cp ./example.env ./.env # adjust the environment variables to your needs
28+
uv run ./cli.py compose-watch
2829
```
2930

3031
The development server of the example project will be started on <http://localhost:8000>
3132

32-
If a library dependency is changed, the containers need to be rebuilt (e.g. by running
33-
`uv run ./cli.py compose-down && uv run ./cli.py compose-up`).
33+
File changes will be automatically detected and the servers will be restarted. When library
34+
dependencies are changed, the containers will automatically be rebuilt and restarted.
35+
36+
## Reporting Issues
37+
38+
If you encounter bugs or have feature requests, please open an issue on GitHub. Include as much detail as possible, including steps to reproduce the issue.
39+
40+
## Making Changes
41+
42+
1. Fork the repository and create a new branch for your feature or bug fix.
43+
2. Make your changes and ensure that they adhere to the Google Python Style Guide.
44+
3. Write tests for your changes and ensure that all tests pass.
45+
4. Commit your changes to a new branch with a clear and descriptive commit message.
46+
5. Push your changes to your forked repository and create a pull request against the main repository.
47+
6. Ensure that your pull request is linked to an issue in the main repository.
48+
49+
## License
50+
51+
By contributing, you agree that your contributions will be licensed under the AGPL-3.0 license.

0 commit comments

Comments
 (0)