Skip to content

Commit 57f8e0a

Browse files
committed
Add best practices for contributions
1 parent 57a3d12 commit 57f8e0a

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
How to Contribute to aima-python
2+
==========================
3+
4+
Thanks for considering contributing to aima-python.
5+
6+
Contributing a Patch
7+
====================
8+
9+
1. Submit an issue describing your proposed change to the repo in question.
10+
1. The repo owner will respond to your issue promptly.
11+
1. Fork the desired repo, develop and test your code changes.
12+
1. Submit a pull request.
13+
14+
Reporting Issues
15+
================
16+
17+
- Under which versions of Python does this happen?
18+
19+
- Is anybody working on this?
20+
21+
Patch Rules
22+
===========
23+
24+
- Ensure that the patch is python 3.5 compliant.
25+
26+
- Include tests if your patch is supposed to solve a bug, and explain
27+
clearly under which circumstances the bug happens. Make sure the test fails
28+
without your patch.
29+
30+
- Try to follow `PEP8 <http://legacy.python.org/dev/peps/pep-0008/>`_, but you
31+
may ignore the line-length-limit if following it would make the code uglier.
32+
33+
Running the Test-Suite
34+
=====================
35+
36+
The minimal requirement for running the testsuite is ``py.test``. You can
37+
install it with::
38+
39+
pip install pytest
40+
41+
Clone this repository::
42+
43+
git clone https://github.com/aimacode/aima-python.git
44+
45+
Then you can run the testsuite with::
46+
47+
py.test

0 commit comments

Comments
 (0)