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

A few small fixes to documentation #62

Merged
merged 6 commits into from
Sep 25, 2023
Merged

A few small fixes to documentation #62

merged 6 commits into from
Sep 25, 2023

Conversation

tcmoore3
Copy link
Member

@tcmoore3 tcmoore3 commented Sep 19, 2023

Description

  • Update CONTRIBUTING.md to reflect that the default branch is trunk, not main
  • Add file listing contributors

Motivation and context

Code–documentation consistency = good

How has this been tested?

Visual inspection of relevant markdown files.

Checklist:

The default branch is `trunk`, not `main`.
@tcmoore3 tcmoore3 requested review from a team and SchoeniPhlippsn and removed request for a team September 19, 2023 13:27
There is no CONTRIBUTORS.md file
@tcmoore3 tcmoore3 changed the title List correct branch to base changes on in CONTRIBUTING.md A few small fixes to documentation Sep 19, 2023
@@ -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.
Copy link
Member

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]>

@tcmoore3 tcmoore3 requested a review from joaander September 23, 2023 02:09
Copy link
Member

@joaander joaander left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

CONTRIBUTORS.md Outdated Show resolved Hide resolved
@joaander joaander merged commit 48a1592 into trunk Sep 25, 2023
1 check passed
@joaander joaander deleted the tcmoore3-docfix branch September 25, 2023 13:31
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.

2 participants