Skip to content

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

Merged
merged 4 commits into from
Feb 23, 2022

Conversation

dreamorosi
Copy link
Contributor

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:
image

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.

@dreamorosi dreamorosi added the documentation Improvements or additions to documentation label Feb 23, 2022
@dreamorosi dreamorosi added this to the production-ready-release milestone Feb 23, 2022
@dreamorosi dreamorosi self-assigned this Feb 23, 2022
Copy link
Contributor

@ijemmy ijemmy left a 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.

dreamorosi and others added 2 commits February 23, 2022 12:33
@dreamorosi dreamorosi changed the title docs: added TL;DR; section to contributing docs docs: added summary section to contributing docs Feb 23, 2022
@dreamorosi
Copy link
Contributor Author

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.

I like both your proposals better, thanks for the suggestions. Updated also the title of the PR.

ijemmy
ijemmy previously approved these changes Feb 23, 2022
Copy link
Contributor

@saragerion saragerion left a 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]>
@dreamorosi dreamorosi merged commit 04caf46 into main Feb 23, 2022
@dreamorosi dreamorosi deleted the docs/added_tldr_to_contrib branch February 23, 2022 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants