Skip to content

Commit

Permalink
Merge pull request #520 from afuetterer/housekeeping
Browse files Browse the repository at this point in the history
chore: housekeeping
  • Loading branch information
huberrob authored Jul 24, 2024
2 parents e2d50de + 22d4e14 commit ac448db
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 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
7 changes: 4 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,13 @@ include = [
packages = ["fuji_server"]

[tool.hatch.envs.default]
dev-mode = true
features = [
"lint",
"testing"
]
post-install-commands = [
"pre-commit install"
]

[tool.hatch.envs.default.scripts]
cov = "pytest --cov {args}"
Expand All @@ -145,10 +147,9 @@ markers = [
testpaths = "tests"

[tool.ruff]
line-length = 120
# Ref: https://docs.astral.sh/ruff/configuration/
line-length = 120
src = ["fuji_server"]
target-version = "py311"

[tool.ruff.lint]
extend-select = [
Expand Down

0 comments on commit ac448db

Please sign in to comment.