-
-
Notifications
You must be signed in to change notification settings - Fork 224
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
TASK: Tweak README #5137
TASK: Tweak README #5137
Conversation
This converts the `Readme.rst` to Markdown and splits it into two separate files, `README.md` and `CONTRIBUTING.md` as is convention these days.
TODO:
|
I guess you want to address the checklist in follow up PRs? |
🤷 What would be the best way to "connect" the READMEs of the dist and collection repositories? |
I guess improving the dev dist readme is a different task… |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, i guess the catchup trigger changes snuck in somehow because your base branch was stale?
Could be, yes. |
This converts the
Readme.rst
to Markdown and splits it into two separate files,README.md
andCONTRIBUTING.md
as is convention these days.Checklist
Code follows the PSR-2 coding styleTests have been created, run and adjusted as neededThe PR is created against the lowest maintained branchFEATURE|TASK|BUGFIX
Reviewer - Breaking Changes are marked with!!!
and have upgrade-instructions