Skip to content

Commit f4084ff

Browse files
committed
Merge pull request exercism#161 from exercism/readme
README: Some advice for contributors
2 parents 5c5e684 + 79d1c3e commit f4084ff

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,48 @@ Exercism exercises in Python
88

99
Please see the [contributing guide](https://github.com/exercism/x-api/blob/master/CONTRIBUTING.md#the-exercise-data)
1010

11+
## Working on the Exercises
12+
13+
We welcome both improvements to the existing exercises and new exercises.
14+
A pool of exercise ideas can be found in the [x-common repo](https://github.com/exercism/x-common).
15+
16+
All exercises must be compatible with Python versions 2.7, 3.3 and 3.4.
17+
Therefore please test your changes at least with Python2.7 and Python3.4.
18+
19+
To test a single exercise, say crypto-square, run:
20+
```
21+
python2.7 test/check_exercises.py crypto-square
22+
```
23+
and
24+
```
25+
python3.4 test/check_exercises.py crypto-square
26+
```
27+
28+
To run the tests for all exercises type:
29+
```
30+
python test/check_exercises.py
31+
```
32+
33+
## Code Style
34+
35+
The Python code in this repo is meant to largely obey the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/) (not all code does though).
36+
Try the [flake8](http://flake8.readthedocs.org/en/latest/) tool if you feel unsure about questions of style.
37+
38+
## Pull Requests
39+
40+
We :heart: pull requests!
41+
We even :sparkling_heart: them if they contain well written commit messages!
42+
43+
Please write the first line of your commit message in the following style:
44+
45+
```exercise-name: Changes some things```
46+
47+
If there are more details to add, put those into the body of the commit message.
48+
49+
If you're interested, Tim Pope even has an [entire blog post](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) on good commit messages.
50+
51+
If you're new to Git take a look at [this short guide](http://help.exercism.io/git-workflow.html).
52+
1153
## License
1254

1355
The MIT License (MIT)

0 commit comments

Comments
 (0)