Skip to content

Commit

Permalink
docs: update contributor guide
Browse files Browse the repository at this point in the history
  • Loading branch information
afuetterer committed Jul 23, 2024
1 parent 2a076be commit 22d4e14
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/pangaea-data-publisher/fuji/issues>.

If you are reporting a bug, please include:

Expand All @@ -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 <https://github.com/pangaea-data-publisher/fuji/issues>.

If you are proposing a feature:

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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."
Expand All @@ -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
<https://github.com/pangaea-data-publisher/fuji/pulls>
and make sure that all the tests pass.

## Tips
Expand Down

0 comments on commit 22d4e14

Please sign in to comment.