From 27ed6f29b3264933166e843fb270f2fe0a1f69fd Mon Sep 17 00:00:00 2001 From: Andrew Schwartz Date: Wed, 2 Dec 2020 09:18:23 -0700 Subject: [PATCH] chrore(contributing): add PR naming section, formating * add details about naming PRs * format commit messages as code * add link to license --- CONTRIBUTING.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a7375e891..1c48330b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,12 +44,24 @@ The issue queue is the place for bug reports or feature requests. To make sure y We use the pull request (PR) process to test and discuss proposed changes to the website. Anyone can open a pull request, and the process for reviewing and merging requests is the same for everyone. -**Important**: By submitting a PR, you agree to license your work under the same license as that used by the project. +**Important**: By submitting a PR, you agree to license your work under the same [license as that used by the project](https://github.com/COVID19Tracking/website/blob/master/LICENSE). Before preparing a pull request, open an issue if there isn’t already one that your request fixes. We use issues to discuss options before deciding on a single approach. For tiny changes, like a typo, a separate issue is not needed. All pull requests run automated tests and deploy a test version of the site to preview changes. It’s OK if a draft or work-in-progress pull request is not passing, all tests and checks must be passing before the request can be merged. The deploy preview is very helpful for others to review your code, and is available in the “Details” link next to a check that will read “Deploy preview ready!” +### Naming pull requests + +#### Single-contributor pull requests + +If you are the only contirbutor to a PR, use this naming convention: `/-[optional-related-issue]` + +This could look like: `octocat/add-notes-highlighting` or `octocat/fix-time-offset-1032` (where 1032 refers to a related issue). + +#### Multi-contributor pull requests or project pull requests + +Pull requests that involve multiple contributors or that have a large scope (i.e. many issues) should use this naming convention: `feature/`. + ### Reviewing, approving and merging pull requests When reviewing a PR, first be compassionate and responsive. People are contributing to the COVID Tracking Project because they care deeply, as you do, about the health of our communities during this crisis. Make suggestions using [Github line suggestions](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request) if possible. When writing feedback, make sure to highlight if one is optional (not required). @@ -62,9 +74,9 @@ Merges should only be made by the core website team, after a PR was reviewed and Write your commit messages and PR titles following the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.3/) format. The pattern is `([optional scope]): Message,`, for example: `fix(docs): Fixed typos in contributor documentation`. They should be both concise and specific. Examples of good commit messages are: -- fix(design): Added more padding to buttons -- chore(docs): Copy edit the contributing page -- feat(visualization): Added new +- `fix(design): Added more padding to buttons` +- `chore(docs): Copy edit the contributing page` +- `feat(visualization): Added new` Examples of unhelpful messages: