Make README more readable. #574
Merged
Conversation
This file contains hidden or 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
june128
commented
Jan 9, 2019
june128
added
the
Chapter Edit
leios
reviewed
Jan 9, 2019
leios
approved these changes
Jan 9, 2019
|
No problem! |
Make README more readable.
- Use a list for the enumeration of links to other interesting sites/
platforms/things in the second paragraph.
- Use an absolute link to the How-to-Contribute chapter to make the
sentence less convoluted.
- Fix markdown style issues.
- https://github.com/DavidAnson/markdownlint/blob/v0.11.0/doc/
Rules.md#md012
- https://github.com/DavidAnson/markdownlint/blob/v0.11.0/doc/
Rules.md#md022
- https://github.com/DavidAnson/markdownlint/blob/v0.11.0/doc/
Rules.md#md034
Apply suggested changes.
- Shorten the entries of the link list as suggested by Leios:
https://github.com/algorithm-archivists/algorithm-archive/pull/
574#discussion_r246228118
- Link to the How to Contribute wiki entry instead of the How to
Contribute chapter. Follow Leios' suggestion by doing so:
https://github.com/algorithm-archivists/algorithm-archive/pull/
574#discussion_r246227846
june128
force-pushed
the
improve_readme
branch
from
b28b920 to
3bdc9e5
Compare
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.
It always bothered me that the links in the second paragraph of the README are quite convoluted, so I went ahead and put them in a list. I also did made a few little other improvements.
List of stuff I changed
Rules.md#md012
Rules.md#md022
Rules.md#md034