Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 4.66 KB

for_trussels.md

File metadata and controls

53 lines (38 loc) · 4.66 KB
Raw

For Trussels

Below is documentation specifically to provide guidance for contributors who work at Truss. If you don't work at Truss, please feel free to ignore!

Internal Communication

We have a Truss Slack channel dedicated to discussing this project (#g-uswds), as well as a channel for automated updates such as new issues, pull requests, and releases (#react-uswds-feed). Anyone is welcome to join and participate in these channels, whether or not they are an active maintainer.

External Communication

We also have a public Slack channel (#g-uswds-public) for the community to engage with Trussels, similar to the repo's Discussions. This is particularly helpful for live conversations and rapid async discussions that a public Discussion or Issue might not be appropriate for. Participation in the channel should abide by our code of conduct and requires a direct email invitation from a Trussel via Slack.

Active Maintainers

See "For Maintainers" README. 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:

  • Join the #react-uswds Slack channel.
  • If you haven't already, be sure to familiarize yourself with this repo, especially the docs on contributing and releasing. Also, review recent releases.
  • 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
  • Optional: Add yourself to the contributors list in the the README, using the command yarn contributors:add [your github username] code
  • Optional: Add yourself to 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!

  • Check out any open pull requests that might need reviews or feedback
  • Take a look at the project board to get a sense of current and upcoming work
    • Issues in the Ready for development column should have clear scope and acceptance criteria, and are ready to be worked on!
      • 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 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:

  • If you have any in-progress work that you won't be able to complete:
    • Make sure all of your commits have been pushed up to a branch so nothing gets lost on your local machine
    • 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!
  • For Maintainers: Open a new PR that removes yourself from the Active Maintainers list in the readme.
  • Remove yourself from 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.
  • Optional: You don’t need to have npm access revoked, but you can if you want.
  • Optional: You don’t need to have Happo admin access revoked, but you can if you want.
  • Optional: If you want to, feel free to leave the #react-uswds Slack channels