From 3c287240a550b062b95d17687d210a9610237b78 Mon Sep 17 00:00:00 2001 From: Hana Worku Date: Mon, 17 Aug 2020 09:55:34 -0500 Subject: [PATCH] Add notes about merging external contributions --- docs/contributing.md | 4 +++- docs/for_trussels.md | 12 ++++++++---- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 7bb6a5c68b..29e7b71c92 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -63,7 +63,9 @@ Create a new branch off `main` using the naming convention: For example: `hw-accordion-component-112`, `hw-accordion-component-112` -When your branch is ready for review, open a PR into `main` and request reviews from relevant team members. Reviews from codeowners will automatically be requested. Address any failing tests, lint errors, PR feedback, etc. Once your branch is approved, the work will be merged with **squash & merge**. +When your branch is ready for review, open a PR into `main` and request reviews from relevant team members. Reviews from codeowners will automatically be requested. Address any failing tests, lint errors, PR feedback, etc. Once the works approved, the work will be merged with **squash & merge**. + +> Note: Currently our CI cannot run directly on external PRs (work from outside the Truss organization) and this prevents merge. To manage this, we pull these PRs into a separate branch that a CODEOWNER creates, run automation, and merge from there. Your initial PR will be closed with a comment and your work will be merged instead from the related PR. ### Guidelines diff --git a/docs/for_trussels.md b/docs/for_trussels.md index e9a0e7af5b..9035383b45 100644 --- a/docs/for_trussels.md +++ b/docs/for_trussels.md @@ -20,9 +20,9 @@ Regardless of whether you are on client work or Reserve, it is _up to each indiv - Watch [USWDS](https://github.com/uswds/uswds) updates, and create new issues needed to help this project stay up-to-date with them - Participate in PR reviews, issue discussion, and project roadmap planning - Address any security alerts that come up promptly (see below) -- Shepherd library releases forward and publish to npm. See [releasing documentation](./docs/for_trussels.md). +- Shepherd library releases forward and publish to npm. See [releasing documentation](./docs/for_trussels.md). - Maintain the project board. -- Prevent PRs and issues from becoming stale, and clean up the ones that do. +- Prevent PRs and issues from becoming stale, and clean up the ones that do. - Moderate discussions to keep alignment with [Truss values](https://truss.works/values) - Administrative the repo's [Happo Account](https://happo.io/). Once you have access, log into Happo.io with your Truss email and you will be able to approve/reject changes on PRs. [Happo docs](https://docs.happo.io/docs/getting-started) have more information. @@ -30,16 +30,20 @@ Regardless of whether you are on client work or Reserve, it is _up to each indiv Typically any security alerts we receive will be related to third-party dependencies. This repo is currently configured so that Dependabot will automatically open PRs that fix dependency vulnerabilities, so ideally most of the time manual intervention is not needed. There may also be periods of time during which an alert is issued, but the related dependencies have not yet updated -- in this case, we usually choose to accept the risk of waiting until the updates have been released. However, if an exceptional case comes up -- such as a high severity vulnerability or even a vulnerability within this library -- and you aren't sure how to handle it, you can ask for help in one of the following Truss Slack channels (in order of relevance): #react-uswds, #g-frontend, #infrasec, #engineering +### Merging External PRS + +Currently our CI cannot run on external PRs (work from outside the Truss organization). This prevents merge. To manage this, we pull PRs into a separate branch that a CODEOWNER creates [using this script](https://github.com/jklukas/git-push-fork-to-upstream-branch) We then close the external contribution PR [with a comment](https://github.com/trussworks/react-uswds/pull/375#issuecomment-668116811) explaining what's going. This allows automation to run properly. This is temporary solution. + ## 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 +- [ ] Join the #react-uswds Slack channel. - [ ] If you haven't already, be sure to familiarize yourself with this repo, especially the docs on [contributing](./contributing.md) and [releasing](./releasing.md). Also, review [recent releases](https://github.com/trussworks/react-uswds/releases). - [ ] Open a new PR that adds yourself to the Active Maintainers list in the [readme](../README.md). - [ ] _Optional:_ Speak with another active maintainer and request admin privileges to the [Happo Account](https://happo.io/) - [ ] _Optional:_ Add yourself to the `contributors` list in the [package.json](../package.json), - - [ ] _Optional: Add yourself to [CODEOWNERS](../CODEOWNERS) if you'd like to automatically be requested to review PRs. + - [ ] \_Optional: Add yourself to [CODEOWNERS](../CODEOWNERS) if you'd like to automatically be requested to review PRs. - [ ] _Optional:_ If you want access to the npm org so you can publish new releases, ping `@npm-admins` in Slack If you've completed all of the above and are wondering what to do next, here are some ideas!