-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
169dd50
commit e17019e
Showing
2 changed files
with
57 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing to the BCI-dockerfile-generator | ||
|
||
## Opening an Pull Request | ||
|
||
The BCI-dockerfile-generator documentation has a section on contributing a | ||
new container or modifying an existing container. Please check the chapter | ||
**Adding and modifying containers** for details. | ||
|
||
Before creating a pull request, please format your source code with Ruff, | ||
which is installed in the Poetry virtual environment by default: | ||
|
||
```bash | ||
poetry run ruff format | ||
# reorder imports: | ||
poetry run ruff check --fix | ||
``` | ||
|
||
Additionally, run the unit tests and check whether the documentation builds | ||
(additional points if you update it): | ||
|
||
```bash | ||
# tests | ||
poetry run pytest -vv | ||
# docs | ||
poetry run sphinx-build -M html source build -W | ||
``` | ||
|
||
|
||
## Reviewing a Pull Request | ||
|
||
The following guidelines are respected by the maintainers on reviewing a Pull Request: | ||
|
||
* CI failures are treated seriously. As a general rule changes with failing CI are not being merged. | ||
|
||
* A reviewer who has requested a change should be notified when the feedback | ||
has been handled. This can be done by clicking the "re-request review" button | ||
on the particular reviewers handle. | ||
|
||
* A pull request is considered mergeable if it has no outstanding change | ||
requests, at least one approval by the maintainers and sufficient time has | ||
passed. Sufficient time means a business workday since initial creation. | ||
|
||
* For changes that touch areas where there are subject matter experts (e.g. | ||
the documentation team for documentation changes), the reviewer or the author | ||
of the PR takes responsibility that these experts had an opportunity to | ||
provide feedback before merging. | ||
|
||
* *Single Review*: The reviewers address the most important issues in the | ||
first review. Minor issues can be commented, for example with a 'NIT:' | ||
prefix. These can be addressed in a followup change or documented for later | ||
in an issue tracker entry. We avoid trickling in further feedback over the | ||
whole review process so that the pull request author understands what the | ||
outstanding action items are upfront. |
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