exercism/python
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update README to warn about Repo Re-org

Browse Source
This commit is contained in:
BethanyG
2021-02-12 08:56:32 -08:00
parent e02c140512
commit 42ad7c0fe8
1 changed files with 12 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@@ -5,33 +5,24 @@
Exercism exercises in Python
:wave: Thank you for your interest in contributing to the exercism Python track!
:warning: **Please Note** :warning:
We are currently in the middle of re-arranging and re-configuring our track for exercism V3.
We're **super-excited** :tada: :rocket: -- _and we really want you to be involved!_ -- but all that inital configuration work means our maintainers can't accept unsolicited contributions at this time.
Please check our [issue list](https://github.com/exercism/python/labels/help%20wanted) for tasks we've flagged as `[help wanted]` -- _and check back_ -- we'll be adding (_many more!_) tasks with that flag in the coming weeks as we update our documentation and identify exercises, documents, and bugs that need to be worked on before our V3 launch.
## Contributing Guide
Please see the [Exercism contributing guide](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md)
and the [Python track contributing guide](CONTRIBUTING.md)
## Working on the Exercises
We welcome both improvements to the existing exercises and new exercises.
A list of missing exercise can be found here: https://github.com/exercism/python/issues/417#issuecomment-366040062
### Conventions
- We use minimalistic stub files for all exercises ([#272](https://github.com/exercism/python/issues/272)).
- We use `unittest` (Python Standard Library) and no 3rd-party-framework.
- We use the parameter order `self.assertEqual(actual, expected)` ([#440](https://github.com/exercism/python/issues/440)).
- We use context managers (`with self.assertRaises(\<exception type\>):`) for testing for exceptions ([#477](https://github.com/exercism/python/issues/477)).
- We use an established utility method to confirm that expected exceptions contain a non-empty message. This method must be included for any test class with an exception-based test case ([#1080](https://github.com/exercism/python/issues/1080#issuecomment-442068539)).
- We use `assertIs(actual, True)` and `assertIs(actual, False)` rather than `assertTrue(actual)` or `assertFalse(actual)` ([#419](https://github.com/exercism/python/pull/419)).
- We use a comment string in the test file to reference the version of the exercise's `canonical-data.json` that tests were adapted from (wording can be found in: [#784](https://github.com/exercism/python/issues/784)).
Our WIP V3 documenatation can be found here: [exercism V3](https://github.com/exercism/docs).
### Testing
All exercises must be compatible with Python version 3.4 upwards.
All exercises must be compatible with Python version 3.8 upwards. We no longer support Python 2.x.
To test a single exercise:
```
@@ -53,25 +44,6 @@ This repo uses [flake8](http://flake8.readthedocs.org/en/latest/) with default s
### CI build
This repo uses `travis-ci` in the following configuration: [travis.yml](https://github.com/exercism/python/blob/master/.travis.yml)
It will automatically check the code style, the problem configuration, and run the unittests with all supported Python versions.
## 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: Change some things```
Please try to follow the [The seven rules of a great Git commit message](https://chris.beams.io/posts/git-commit/#seven-rules) like to capitalize the subject line and use the imperative mood. 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](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md#git-basics).
## License
This repository uses the [MIT License](/LICENSE).