From 22d4e14764d4a7b735ffbab6247d0ef4bf8914c4 Mon Sep 17 00:00:00 2001 From: Heinz-Alexander Fuetterer Date: Tue, 23 Jul 2024 18:23:23 +0200 Subject: [PATCH] docs: update contributor guide --- CONTRIBUTING.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 205eeb04..75de9a13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ You can contribute in many ways: ### Report Bugs -Report bugs at https://github.com/pangaea-data-publisher/fuji/issues. +Report bugs at . If you are reporting a bug, please include: @@ -33,7 +33,7 @@ articles, and such. ### Submit Feedback -The best way to send feedback is to file an issue at https://github.com/pangaea-data-publisher/fuji/issues. +The best way to send feedback is to file an issue at . If you are proposing a feature: @@ -46,7 +46,7 @@ If you are proposing a feature: Ready to contribute? -You need Python 3.8+ and [hatch](https://github.com/pypa/hatch). You can install it globally with [pipx](https://github.com/pypa/pipx): +You need Python 3.11+ and [hatch](https://github.com/pypa/hatch). You can install it globally with [pipx](https://github.com/pypa/pipx): ```console $ pipx install hatch @@ -69,7 +69,6 @@ Here's how to set up F-UJI for local development. ```console $ cd fuji $ hatch shell - $ pre-commit install ``` 4. Create a branch for local development: ```console @@ -84,7 +83,7 @@ Here's how to set up F-UJI for local development. $ hatch run test ``` -6. Commit your changes and push your branch to GitHub:: +6. Commit your changes and push your branch to GitHub: ```console $ git add . $ git commit -m "Your detailed description of your changes." @@ -100,8 +99,8 @@ Before you submit a pull request, check that it meets these guidelines: 1. The pull request should include tests. 2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring. -3. The pull request should work for Python >= 3.8. Check - https://github.com/pangaea-data-publisher/fuji/pulls +3. The pull request should work for Python >= 3.11. Check + and make sure that all the tests pass. ## Tips