Skip to content

README: Some advice for contributors #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kytrinyx merged 1 commit into from
Apr 26, 2015
Merged

README: Some advice for contributors #161

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,48 @@ Exercism exercises in Python

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

## Working on the Exercises

We welcome both improvements to the existing exercises and new exercises.
A pool of exercise ideas can be found in the [x-common repo](https://github.com/exercism/x-common).

All exercises must be compatible with Python versions 2.7, 3.3 and 3.4.
Therefore please test your changes at least with Python2.7 and Python3.4.

To test a single exercise, say crypto-square, run:
```
python2.7 test/check_exercises.py crypto-square
```
and
```
python3.4 test/check_exercises.py crypto-square
```

To run the tests for all exercises type:
```
python test/check_exercises.py
```

## Code Style

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).
Try the [flake8](http://flake8.readthedocs.org/en/latest/) tool if you feel unsure about questions of style.

## Pull Requests

We :heart: pull requests!
We even :sparkling_heart: them if they contain well written commit messages!

Please write the first line of your commit message in the following style:

```exercise-name: Changes some things```

If there are more details to add, put those into the body of the commit message.

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.

If you're new to Git take a look at [this short guide](http://help.exercism.io/git-workflow.html).

## License

The MIT License (MIT)
Expand Down