Skip to content

Commit

Permalink
Adding contribute documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tdegeus committed Feb 28, 2024
1 parent 569a9f2 commit c74cc69
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 1 deletion.
36 changes: 36 additions & 0 deletions docs/source/contribute.rst
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),
1 change: 1 addition & 0 deletions docs/source/customize.rst
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ If you want to change these defaults, specify them in the call to the super cons
Community-Provided Middleware
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

We encourage users to provide their own middleware layers and share them with the community.
We are happy to provide a list of community-provided middleware layers here, so please let us know if you have written one!

Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Contents:
install.rst
quickstart.rst
customize.rst
contribute.rst
migrate.rst
biber.rst
bibtexparser.rst
Expand Down
1 change: 0 additions & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
Installation
============


Requirements
------------

Expand Down

0 comments on commit c74cc69

Please sign in to comment.