Skip to content

Commit 73c84bb

Browse files
committed
Updates contributing.md
1 parent 8eb1cb8 commit 73c84bb

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Contributing to Python-RAT
2+
==========================
3+
Everyone is welcome to contribute to the Python-RAT project by either opening an issue (please check that the
4+
issue has not been reported already) or submitting a pull request.
5+
6+
Create Developer Environment
7+
----------------------------
8+
This project targets Python 3.9 or later. Install an appropriate version of Python and other dependencies
9+
10+
Then create a fork of the python-RAT repo, and clone the fork
11+
12+
git clone https://github.com/<username>/python-RAT.git
13+
cd python-RAT
14+
15+
And finally create a separate branch to begin work
16+
17+
git checkout -b new-feature
18+
19+
Once complete submit a [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) via GitHub.
20+
Ensure to rebase your branch to include the latest changes on your branch and resolve possible merge conflicts.
21+
22+
Unit-testing and coverage
23+
-------------------------
24+
Python-RAT will use the **unittest** module for testing. Proper documentation and unit tests is highly recommended.
25+
26+
Documentation
27+
-------------
28+
The documentation will be hosted on GitHub pages
29+
30+
Style guidelines
31+
----------------
32+
* Docstrings should be written in the reStructuredText format.

0 commit comments

Comments
 (0)