-
Notifications
You must be signed in to change notification settings - Fork 132
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
Showing
4 changed files
with
38 additions
and
1 deletion.
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,36 @@ | ||
========== | ||
Contribute | ||
========== | ||
|
||
Contributions to this open-source project are strongly encouraged. | ||
If you would like to contribute to the project, please fork the repository and submit a pull request. | ||
A few guidelines to keep in mind: | ||
|
||
* Please make sure that your code is well-documented by adding comprehensive docstrings. | ||
Indicate the purpose of the function, the input parameters, and the expected output. | ||
|
||
* Please add unit tests to the ``tests`` directory (in existing or new files) | ||
to ensure that the code is functioning as expected. | ||
Run the tests using the command ``pytest`` in the root directory of the project | ||
(we refer to the [pytest documentation](https://docs.pytest.org) for more information, | ||
e.g. about verbose output). | ||
|
||
If you need to install: | ||
```bash | ||
python -m pip install pytest | ||
``` | ||
|
||
* Respect the coding conventions by running the linters | ||
(i.e. you don't have to worry during coding, formatting is automatically applied by the linters). | ||
Run: | ||
```bash | ||
pre-commit run --all-files | ||
``` | ||
|
||
If you need to install: | ||
```bash | ||
python -m pip install pre-commit | ||
``` | ||
(and if you don't want to, you can either run the linters manually, | ||
with settings in ``.pre-commit-config.yaml``, | ||
or apply modifications based on the CI output), |
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
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
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 |
---|---|---|
|
@@ -2,7 +2,6 @@ | |
Installation | ||
============ | ||
|
||
|
||
Requirements | ||
------------ | ||
|
||
|