From 885c560200210eea060df3a058a01ccdfcb909a7 Mon Sep 17 00:00:00 2001 From: Nathan Parsons Date: Tue, 24 Oct 2017 12:07:42 +0100 Subject: [PATCH] README: Add new conventions and add links to relevant issues/PRs --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 93e5983408..873c814134 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,12 @@ A list of missing exercise can be found here: http://exercism.io/languages/pytho ### 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 the parameter order `self.assertEqual(actual, expected)` (#440). -- We use context managers (`with self.assertRaises(\):`) for testing for exceptions (#477). +- We use the parameter order `self.assertEqual(actual, expected)` ([#440](https://github.com/exercism/python/issues/440)). +- We use context managers (`with self.assertRaises(\):`) 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 @@ -56,12 +58,12 @@ It will automatically check the code style, the problem configuration, and run t ## Pull Requests -We :heart: 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``` +```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.