-
Notifications
You must be signed in to change notification settings - Fork 154
docs: added summary section to contributing docs #573
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
Conversation
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.
Not sure about the 2nd proposed change. May be too long?
But I do feel that we shouldn't use "TL;DR;" here. It is like telling them that it is ok to not read.
Co-authored-by: ijemmy <[email protected]>
Co-authored-by: ijemmy <[email protected]>
I like both your proposals better, thanks for the suggestions. Updated also the title of the PR. |
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.
Added a minor suggestion :) thanksss
Co-authored-by: Sara Gerion <[email protected]>
Description of your changes
Following some confusion from community contributors and maintainers alike this PR adds a terse TL;DR; (aka too long; didn't read) section at the top of the
CONTRIBUTING.md
document to allow new contributors more easily get started.How to verify this change
Check changes in the Markdown file, preview below:

Related issues, RFCs
N/A
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
N/A
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.