Skip to content

Commit d7ed1ee

Browse files
authored
Create CONTRIBUTING.md
just copy-pasted the rst from https://b3yc0d3.github.io/rule34Py/dev/contributing.html and converted it to markdown
1 parent 993b5a1 commit d7ed1ee

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
Thanks for taking an interest in contributing to the rule34Py project!
4+
5+
* This project's **canonical upstream** is at https://github.com/b3yc0d3/rule34Py.
6+
* File **bugs**, **enhancement requests**, and other **issues** to the GH issue tracker at https://github.com/b3yc0d3/rule34Py/issues.
7+
* See the [Developer Guide](https://b3yc0d3.github.io/rule34Py/dev/developer-guide.html) for information about how to **build** this project from source and run tests.
8+
9+
10+
## Submitting Changes
11+
12+
#. Base your development branch off of the [upstream](https://github.com/b3yc0d3/rule34Py/tree/develop) ``develop`` reference.
13+
14+
#. Before committing your changes, run the **project linter** using ``make``. It will use the ``ruff`` to lint all the project sources.
15+
16+
.. code-block:: bash
17+
18+
poetry install # Optional, if you have not done it previously.
19+
make lint
20+
21+
Fix or respond to any findings in the linter.
22+
23+
#. Run the project's test suite against your changes. Ensure that all tests pass.
24+
25+
.. code-block:: bash
26+
27+
poetry install # Optional, if you have not done it previously.
28+
make check
29+
30+
#. Write a good commit message. If you are unsure of how, [this cbeams article](https://cbea.ms/git-commit/) gives reasonable suggestions. Commit your changes.
31+
32+
#. Fork the canonical upstream repository on github. \[[GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)\]
33+
34+
#. Push your development branch to your own fork. [Open a new Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) against the upstream `develop` ref.
35+
36+
#. Submit your PR. Respond to any PR build failures or feedback from the maintainers.

0 commit comments

Comments
 (0)