-
Notifications
You must be signed in to change notification settings - Fork 156
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Carmen Bianca BAKKER <[email protected]>
- Loading branch information
1 parent
a7896a5
commit 11be9f0
Showing
1 changed file
with
45 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -45,10 +45,52 @@ may be closed for various reasons, such as: | |
To be safe, open an issue and engage in dialogue before beginning to implement a | ||
feature that may not be accepted. | ||
|
||
When making a pull request, don't hesitate to add yourself to the AUTHORS.rst | ||
file and the copyright headers of the files you touch. | ||
**Pull requests need not be perfect.** Not all the tests need to pass. A pull | ||
request with 80% of the work done is a lot better than no pull request at all. | ||
We can work together on making the pull request merge-ready, or the maintainers | ||
can finalise the pull request for you. | ||
|
||
### Change log | ||
Making a pull request generally necessitates the following steps: | ||
|
||
### Set up local development | ||
|
||
Starting local development is very simple, just execute the following commands: | ||
|
||
```bash | ||
git clone [email protected]:fsfe/reuse-tool.git | ||
cd reuse-tool/ | ||
poetry install # You may need to install poetry using your package manager. | ||
poetry run pre-commit install # Using poetry is optional here if you already have pre-commit. | ||
``` | ||
|
||
Next, you'll find the following commands handy: | ||
|
||
- `poetry run reuse` | ||
- `poetry run pytest` | ||
- `poetry run pylint src` | ||
- `poetry run mypy` | ||
- `make docs` | ||
|
||
### Make changes | ||
|
||
This is the tricky bit for which no development guide exists. You make changes | ||
somewhere in the code. If you can, do the following things: | ||
|
||
- Write docstrings. | ||
- Add type hinting. | ||
- Write tests. | ||
- Update documentation. | ||
- Add self as author to every touched file. | ||
- Add self to `AUTHORS.rst`. | ||
|
||
### Commit and submit a pull request | ||
|
||
As part of committing, `pre-commit` should run some checks. If you can easily | ||
fix them, fix them. If you get stuck here, **do not worry**. Just skip the | ||
pre-commit step with `git commit -n`, and make a pull request. The maintainers | ||
will be happy to fix those annoying things. | ||
|
||
### Make a change log entry | ||
|
||
Every pull request should add a change log entry. Change log entries go into | ||
`changelog.d/<directory>/<name>.md`, where `<directory>` is the appropriate | ||
|
@@ -78,25 +120,6 @@ Broader instructions on how to help the FSFE translate things into local | |
languages can be found at <https://fsfe.org/contribute/translators/>. The | ||
translators keep in touch with the <[email protected]> mailing list. | ||
|
||
## Local development | ||
|
||
Starting local development is very simple, just execute the following commands: | ||
|
||
```bash | ||
git clone [email protected]:fsfe/reuse-tool.git | ||
cd reuse-tool/ | ||
poetry install # You may need to install poetry using your package manager. | ||
poetry run pre-commit install # Using poetry is optional here if you already have pre-commit. | ||
``` | ||
|
||
Next, you'll find the following commands handy: | ||
|
||
- `poetry run reuse` | ||
- `poetry run pytest` | ||
- `poetry run pylint src` | ||
- `poetry run mypy` | ||
- `make docs` | ||
|
||
## Development conventions | ||
|
||
### Poetry | ||
|