-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
From a TODO in #1211. Add documentation for contributors. #1348
Conversation
a9c1732
to
ff73519
Compare
This changes the README file and adds a new section `Contributors`. This section includes instructions to remind contributors to make an update to the changelog.
ff73519
to
90bab79
Compare
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 for your contribution.
As per the comment at #1211 (comment), I think we ideally want this info in a separate CONTRIBUTING.md
file, which could be linked to from the readme.
0eae188
to
469c809
Compare
I feel like the file should be renamed. Although there isn't really any standard for this, I think For example, this is what Hacktoberfest has to say:
|
Yep, I think you are right, |
469c809
to
46eafe5
Compare
46eafe5
to
0157fc3
Compare
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.
Thank you for starting this @adrian-rivera. I added a few more sections to the CONTRIBUTING.md
file.
@eth-p @keith-hall Let me know if you think we should add anything else to the document.
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.
Looks good to me!
This changes the README file and adds a new section
Contributors
.This section includes instructions to remind contributors to make an
update to the changelog.
This relates to #1211