From 2e0f629b97f48d4b232e70f62a8e8db13cca2eeb Mon Sep 17 00:00:00 2001 From: Kate Higa <16447748+khiga8@users.noreply.github.com> Date: Mon, 7 Jun 2021 11:44:41 -0700 Subject: [PATCH] update contributing guidelines (#246) This PR updates the contributing guidelines with squash expectations based on a consensus reached in a recent code discussion meeting. PVC and PRC both have squash enabled. --- docs/contribute.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/contribute.md b/docs/contribute.md index 6d59cef5..a0e073d0 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -54,6 +54,12 @@ Documentation is a core part of Primer, and, just as design and code, we’re al There are issues marked with the label “status: help wanted” across the different Primer repos that we’d love some help with. If you think you can help, add a comment on the issue stating when and (if you know) how you’ll be able to tackle it and we’ll support you throughout. +### Opening a pull request + +When working on an issue, don't worry too much about commit frequency or having the perfect commit message. We squash commits down into a single commit when merging pull requests. + +Instead, we encourage you to be detailed in your pull request descriptions. Be sure to address what change is being made, why the change is being made, and add links to the relevant issue or any references used. + ## Propose a new component or UI pattern If you'd like to propose a new Primer component, let's talk! The best way to get started is to message the design systems team in Slack so we can verify if the request (or similar) is already being worked on. If you prefer, you can submit an issue in the [design-systems repo](https://github.com/github/design-systems) (internal GitHub users only) with as much detail about the proposal as possible: problem statement, user and product needs, context, timelines, and anything else that will help triage the issue.