Skip to content
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

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

Merged
merged 2 commits into from
Oct 25, 2017
Merged

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
885c560
README: Add new conventions and add links to relevant issues/PRs
Oct 24, 2017
6b4a5d0
Merge branch 'master' into update-readme
ilya-khadykin Oct 25, 2017
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
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitHub implicitly links #272 to issue 272 in same repository; is it really necessary to change to explicit links?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the GitHub repo page, these don't appear to be implicitly linked - I probably should have made that clear in the PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right... in fact, they are not implicitly linked even if you click on the README.md file itself. not sure why issue number syntax is implicitly linked everywhere on GitHub except for when viewing actual markdown files. Might be a GitHub bug... good catch.

- 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(\<exception type\>):`) 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(\<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
Expand Down Expand Up @@ -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.

Expand Down