Skip to content
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

Merged
merged 7 commits into from
Oct 29, 2020

Conversation

adrian-rivera
Copy link
Contributor

@adrian-rivera adrian-rivera commented Oct 27, 2020

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

@adrian-rivera adrian-rivera changed the title From a TODO in #1221. Add documentation for contributors. From a TODO in #1211. Add documentation for contributors. Oct 27, 2020
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.
Copy link
Collaborator

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@eth-p
Copy link
Collaborator

eth-p commented Oct 29, 2020

I feel like the file should be renamed. Although there isn't really any standard for this, I think CONTRIBUTING.MD is used more often than CONTRIBUTORS.MD.

For example, this is what Hacktoberfest has to say:

Do: Follow a repository's contribution guidelines

Almost every repo looking for help has a CONTRIBUTING.md file in it, read it first!

@adrian-rivera
Copy link
Contributor Author

I feel like the file should be renamed. Although there isn't really any standard for this, I think CONTRIBUTING.MD is used more often than CONTRIBUTORS.MD.

For example, this is what Hacktoberfest has to say:

Do: Follow a repository's contribution guidelines

Almost every repo looking for help has a CONTRIBUTING.md file in it, read it first!

Yep, I think you are right, CONTRIBUTING seems to be widely use, I'll do the change

Copy link
Owner

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

Copy link
Collaborator

@eth-p eth-p left a 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!

@sharkdp sharkdp merged commit 877d912 into sharkdp:master Oct 29, 2020
@adrian-rivera adrian-rivera deleted the changelog_doc branch October 30, 2020 17:21
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.

4 participants