Migrate docs and GitHub templates to Markdown#663
Open
PtPrashantTripathi wants to merge 1 commit into
Open
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
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.
Fixes # by migrating RST docs and misplaced GitHub templates to Markdown
Changes proposed in this pull request:
README.rst→README.mdandCHANGES.rst→CHANGELOG.md(RST-specific syntax replaced with equivalent Markdown)
PULL_REQUEST_TEMPLATE.mdandISSUE_TEMPLATE.mdfrom the reporoot into
.github/— GitHub only auto-applies these templates whenthey live in that directory
setup.pyto readREADME.md+CHANGELOG.mdforlong_description(was already declaringtext/markdowncontent typewhile reading
.rstfiles — now consistent)MANIFEST.into includeCHANGELOG.mdinstead ofCHANGES.rstStatus
How to verify this change
python setup.py --long-descriptionshould render clean MarkdownREADME.mdandCHANGELOG.mdrender correctly on the GitHub repo page