urschrei.bsky.social
+10
-9
CONTRIBUTING.md
+10
-9
CONTRIBUTING.md
···
1
1
# Contributing
2
2
Contributions are welcome. Please bear the following in mind:
3
3
4
-
- **Base your changes on the dev branch**
5
-
- If necessary, rebase against `dev` before opening a pull request
6
-
- Follow [PEP 8](http://www.python.org/dev/peps/pep-0008/). I currently periodically run [`Black`](https://black.readthedocs.io/en/stable/) against the codebase and perhaps you should, too
7
-
- Use spaces for indentation, and ensure that all methods have a proper docstring. **Please don't use Doctest**
4
+
- **Base your changes on the `main` branch**
5
+
- If necessary, rebase against `main` before opening a pull request
6
+
- This codebase uses Ruff, and PRs are gated on `ruff check` passing. Run `ruff check` locally before opening a PR
7
+
- PRs that reformat code will not be accepted.
8
+
- Ensure that all methods added have a proper docstring. **Please do not use Doctest**
8
9
- If at all possible, don't add dependencies
9
-
- If it's unavoidable, ensure that the dependency is maintained, and supported
10
-
- Ensure that you add your dependency to [setup.py](setup.py)
11
-
- Run the tests, and ensure that they pass. If you're adding a feature, **you must add tests that exercise it**
12
-
- If your pull request is a feature, **document it**
10
+
- If it is unavoidable, you must ensure that the dependency is maintained, and supported
11
+
- Ensure that you add your dependency to [pyproject.toml](pyproject.toml)
12
+
- Run the tests and ensure that they pass. If you are adding a feature **you must add tests that exercise it**
13
+
- If your pull request is a feature **document the feature**
13
14
- One feature per pull request
14
-
- If possible, [squash](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) your commits before opening a pull request, unless it makes no sense to do so
15
+
- [squash](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) your commits before opening a pull request unless it makes no sense to do so
15
16
- If in doubt, comment your code.
16
17
17
18
# License of Contributed Code