Skip to content

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

Merged
ilya-khadykin merged 2 commits into
exercism:masterfrom
N-Parsons:update-readme
Oct 25, 2017
Merged

README: Add new conventions and add links to relevant issues/PRs#977
ilya-khadykin merged 2 commits into
exercism:masterfrom
N-Parsons:update-readme

Conversation

@N-Parsons
Copy link
Copy Markdown
Contributor

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.

Comment thread README.md
### 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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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.

Copy link
Copy Markdown
Contributor

@ilya-khadykin ilya-khadykin left a comment

Choose a reason for hiding this comment

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

👍

@ilya-khadykin ilya-khadykin merged commit 6ba1846 into exercism:master Oct 25, 2017
@N-Parsons N-Parsons deleted the update-readme branch October 25, 2017 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants