Skip to content

Migrate docs and GitHub templates to Markdown#663

Open
PtPrashantTripathi wants to merge 1 commit into
savoirfairelinux:masterfrom
PtPrashantTripathi:chore/migrate-docs-and-templates-to-markdown
Open

Migrate docs and GitHub templates to Markdown#663
PtPrashantTripathi wants to merge 1 commit into
savoirfairelinux:masterfrom
PtPrashantTripathi:chore/migrate-docs-and-templates-to-markdown

Conversation

@PtPrashantTripathi

Copy link
Copy Markdown

Fixes # by migrating RST docs and misplaced GitHub templates to Markdown

Changes proposed in this pull request:

  • Converted README.rstREADME.md and CHANGES.rstCHANGELOG.md
    (RST-specific syntax replaced with equivalent Markdown)
  • Moved PULL_REQUEST_TEMPLATE.md and ISSUE_TEMPLATE.md from the repo
    root into .github/ — GitHub only auto-applies these templates when
    they live in that directory
  • Updated setup.py to read README.md + CHANGELOG.md for
    long_description (was already declaring text/markdown content type
    while reading .rst files — now consistent)
  • Updated MANIFEST.in to include CHANGELOG.md instead of CHANGES.rst

Status

  • READY
  • HOLD
  • WIP (Work-In-Progress)

How to verify this change

  • Open a new PR or issue — the templates should auto-populate
  • python setup.py --long-description should render clean Markdown
  • README.md and CHANGELOG.md render correctly on the GitHub repo page

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.

1 participant