-
Notifications
You must be signed in to change notification settings - Fork 0
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
A few small fixes to documentation #62
Conversation
The default branch is `trunk`, not `main`.
There is no CONTRIBUTORS.md file
.github/PULL_REQUEST_TEMPLATE.md
Outdated
@@ -17,4 +17,3 @@ Resolves #??? | |||
|
|||
- [ ] I have reviewed the [**Contributor Guidelines**](https://github.com/glotzerlab/hoomd-validation/blob/trunk/CONTRIBUTING.md). | |||
- [ ] I agree with the terms of the [**HOOMD-blue Contributor Agreement**](https://github.com/glotzerlab/hoomd-validation/blob/trunk/ContributorAgreement.md). | |||
- [ ] My name is on the list of contributors (`CONTRIBUTORS.md`) in the pull request source branch. |
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.
Keep this line and instead add CONTRIBUTORS.md
along with the needed .mailmap so that git shortlog
produces the expected results.
Here are the contributors on trunk
after removing bots:
324 Joshua A. Anderson <[email protected]>
106 Tommy Waltmann <[email protected]>
19 Tommy Waltmann <[email protected]>
10 tommy-waltmann <[email protected]>
6 Tim Moore <[email protected]>
6 Tim Moore <[email protected]>
3 Brandon Butler <[email protected]>
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!
Description
CONTRIBUTING.md
to reflect that the default branch istrunk
, notmain
Motivation and context
Code–documentation consistency = good
How has this been tested?
Visual inspection of relevant markdown files.
Checklist:
CONTRIBUTORS.md
) in the pull request source branch.