Skip to content

Commit

Permalink
chore: adds shauna to README and updates documentation to reflect usa…
Browse files Browse the repository at this point in the history
…ge of all-contributors CLI (#2194)

* removes my manually entered html from the README.md file

* Add @shkeating as a contributor

* updates documentation to reflect usage of all-contributors CLI

* fixes typo

Co-authored-by: Roger Steve Ruiz <rogeruiz@truss.works>

* removes accidental / character

Co-authored-by: Roger Steve Ruiz <rogeruiz@truss.works>

Co-authored-by: Roger Steve Ruiz <rogeruiz@truss.works>
Co-authored-by: John Gedeon <john@truss.works>
  • Loading branch information
3 people authored Sep 23, 2022
1 parent 1f48d5f commit 57e28a8
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
10 changes: 10 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,16 @@
"bug",
"code"
]
},
{
"login": "Shkeating",
"name": "Shauna Keating",
"avatar_url": "https://avatars.githubusercontent.com/u/59394696?v=4",
"profile": "https://github.com/Shkeating",
"contributions": [
"a11y",
"code"
]
}
],
"contributorsPerLine": 7
Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# @trussworks/react-uswds

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-20-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-21-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

[![npm version](https://img.shields.io/npm/v/@trussworks/react-uswds)](https://www.npmjs.com/package/@trussworks/react-uswds)
Expand Down Expand Up @@ -151,8 +151,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center"><a href="https://github.com/Igarfinkle"><img src="https://avatars.githubusercontent.com/u/7664177?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Isaac Garfinkle</b></sub></a><br /><a href="https://github.com/trussworks/react-uswds/commits?author=Igarfinkle" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/rogeruiz"><img src="https://avatars.githubusercontent.com/u/706004?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Roger Steve Ruiz</b></sub></a><br /><a href="https://github.com/trussworks/react-uswds/commits?author=rogeruiz" title="Code">💻</a> <a href="https://github.com/trussworks/react-uswds/commits?author=rogeruiz" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/lpsinger"><img src="https://avatars.githubusercontent.com/u/728407?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Leo Singer</b></sub></a><br /><a href="https://github.com/trussworks/react-uswds/issues?q=author%3Alpsinger" title="Bug reports">🐛</a> <a href="https://github.com/trussworks/react-uswds/commits?author=lpsinger" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/Shkeating"><img src=https://avatars.githubusercontent.com/u/59394696?v=4s=100" width="100px;" alt=""/><br /><sub><b>Shauna Keating</b></sub></a><br /><a href="https://github.com/trussworks/react-uswds/issues?q=author%3Shkeating" title="a11y">♿️ </a><a href="https://github.com/trussworks/react-uswds/commits?author=Shakeating title="Code">💻</a> </td>

<td align="center"><a href="https://github.com/Shkeating"><img src="https://avatars.githubusercontent.com/u/59394696?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Shauna Keating</b></sub></a><br /><a href="#a11y-Shkeating" title="Accessibility">️️️️♿️</a> <a href="https://github.com/trussworks/react-uswds/commits?author=Shkeating" title="Code">💻</a></td>
</tr>
</table>

Expand Down
9 changes: 5 additions & 4 deletions docs/for_trussels.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ We have a Truss Slack channel dedicated to discussing this project (**#react-usw
## Active Maintainers

See ["For Maintainers" README](for_maintainers.md). There are also some "For Maintainers" notes below.

## Onboarding

First of all, we’re so excited you want to be an active maintainer on this project! Here are the things you should make sure to do:
Expand All @@ -18,8 +19,8 @@ First of all, we’re so excited you want to be an active maintainer on this pro
- [ ] _For Maintainers:_ Add yourself to main project README "Active Maintainers" list.
- [ ] _For Maintainers:_ Ping in #react-uswds to request access to the npm org so you can publish new releases
- [ ] _For Maintainers:_ Ping in #react-uswds to request admin privileges to the [Happo Account](https://happo.io/)
- [ ] _Optional:_ Add yourself to the `contributors` list in the [contributors file](../all-contributorsrc.json),
- [ ] _Optional: Add yourself to [CODEOWNERS](../CODEOWNERS) if you'd like to automatically be requested to review PRs.
- [ ] _Optional:_ Add yourself to the `contributors` list in the [the README](../README.md), using the command `yarn contributors:add [your github username] code`
- [ ] _Optional_: Add yourself to [CODEOWNERS](../CODEOWNERS) if you'd like to automatically be requested to review PRs.

If you've completed all of the above and are wondering what to do next, here are some ideas!

Expand All @@ -29,7 +30,7 @@ If you've completed all of the above and are wondering what to do next, here are
- especially any that are labeled `good first issue` if this is your first time contributing to ReactUSWDS
- Issues in the **Needs requirements** column are undergoing active discussion and would probably benefit from your point of view!
- Browse [open issues](https://github.com/trussworks/react-uswds/issues) to see if there are any new issues that need to be labeled or prioritized

## Offboarding

Please make sure to do the following before you wash your hands of responsibilities:
Expand All @@ -39,7 +40,7 @@ Please make sure to do the following before you wash your hands of responsibilit
- [ ] Open a draft PR for your branch, and use that to annotate any remaining work, TODOs, open questions, etc. as well as the overarching strategy you had in mind. The more documentation you leave, the easier it will be for someone else to finish your work!
- [ ] If there is another active maintainer who is planning to pick up your work, comment on the PR and tag them so it's clear who will be picking it up. If there isn't, or you aren't sure, comment on the PR saying the work needs a new assignee or else it will go stale.
- [ ] Unassign yourself from any corresponding issues
- It’s ideal if you are able to help answer any questions that arise from handing off work, but we understand if your new commitments don't allow for it!
- It’s ideal if you are able to help answer any questions that arise from handing off work, but we understand if your new commitments don't allow for it!
- [ ] _For Maintainers:_ Open a new PR that removes yourself from the Active Maintainers list in the [readme](../README.md).
- [ ] Remove yourself from [CODEOWNERS](../CODEOWNERS) so you don't get PR requests that you won't have time to review.
- **_Don't_** remove yourself from `package.json` contributors! You did good work on this project and that should be recognized.
Expand Down

0 comments on commit 57e28a8

Please sign in to comment.