README: Add new conventions and add links to relevant issues/PRs #977
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cmccandless
reviewed
Oct 24, 2017
| @@ -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)). | |||
There was a problem hiding this comment.
GitHub implicitly links #272 to issue 272 in same repository; is it really necessary to change to explicit links?
There was a problem hiding this comment.
On the GitHub repo page, these don't appear to be implicitly linked - I probably should have made that clear in the PR.
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the README to include a couple of new conventions, and turns the references to relevant issues/PRs where these conventions were discussed/originated into links to make it easier for people to find and understand the reasoning.