Skip to content

Commit 6cef461

Browse files
authored
Create CONTRIBUTING.md
1 parent 397ea51 commit 6cef461

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Before opening a Pull Request, be sure to the "master" branch,
2+
1. Make sure all line endings in \*.py and \*.rst files use only LF (`\n`) and not CRLF (`\r\n`). Especially if you are working from windows.
3+
2. If you made any documentation changes, you should verify, that they render properly as [instructed in the bottom of the documentation's landing page](https://circuitpython-nrf24l01.readthedocs.io/en/latest/#sphinx-documentation).
4+
5+
The "Build CI" github action workflow will also make sure the above stipulations have been adhered to.
6+
7+
It would also help to have a detailed description of the changes in the Pull Request if it is more than 1 or 2 lines of differences.

0 commit comments

Comments
 (0)