Skip to content

Commit f461f99

Browse files
authored
Update Readme.md
1 parent fe020e3 commit f461f99

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

Readme.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -314,9 +314,20 @@ Unsupervised Fraud Detection</a>. Royal Institute of Technology School of Comput
314314
Pages 192-193.</li>
315315
</ul>
316316

317-
Compatibility notes
317+
Guidelines to contribute
318318
---------------------
319-
Minisom has been tested under Python 3.8.0.
319+
1. In the description of your Pull Request explain clearly what does it implements/fixes and your changes. Possibly give an example in the description of the PR. In cases that the PR is about a code speedup, report a reproducible example and quantify the speedup.
320+
2. Give your pull request a helpful title that summarises what your contribution does.
321+
3. Write unit tests for your code and make sure the existing tests are up to date. `pytest` can be used for this:
322+
```
323+
pytest minisom.py
324+
```
325+
4. Make sure that there a no stylistic issues using `pycodestyle`:
326+
```
327+
pycodestyle minisom.py
328+
```
329+
5. Make sure your code is properly commented and documented. Each public method needs to be documented as the existing ones.
330+
320331

321332
License
322333
---------------------

0 commit comments

Comments
 (0)