README: Add new conventions and add links to relevant issues/PRs (#977)

This commit is contained in:
Nathan Parsons
2017-10-25 07:53:53 +01:00
committed by Ilya Khadykin
parent 6b7c4444a7
commit 6ba1846f9c

View File

@@ -19,10 +19,12 @@ A list of missing exercise can be found here: http://exercism.io/languages/pytho
### Conventions ### Conventions
- We use minimalistic stub files for all exercises (#272). - 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 `unittest` (Python Standard Library) and no 3rd-party-framework.
- We use the parameter order `self.assertEqual(actual, expected)` (#440). - 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). - We use context managers (`with self.assertRaises(\<exception type\>):`) for testing for exceptions ([#477](https://github.com/exercism/python/issues/477)).
- 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)).
### Testing ### Testing