Update contributing guide for a general audience #941
Conversation
…oduct-Design 1. https://github.com/product-design does not exist as a user 2. If this was meant to be a reference to a team, it's not possible to ping said team if you're not a member of an organization
…sign-systems This encourages anyone that isn't necessarily a part of the `primer` organization to open an issue and ask for help.
|
This pull request is being automatically deployed with ZEIT Now (learn more). 🔍 Inspect: https://zeit.co/primer/primer-css/ktz7dhko0 |
francisfuzz
changed the title
|
@francisfuzz Thanks for opening this PR. ❤️ 🙇 This
We don't get a lot of outside contributions (maybe because this /cc @primer/design-systems any opinions. I'd vote for option 2. |
simurai
added
type: question
patch release
status: investigate
Tag: Documentation
and removed
type: question
labels
|
Hi @simurai ! Thanks for that lovely evaluation. Based on this context, I'd like to also place my vote for option 2 since it's the lowest effort change and sets expectations up front. If we ultimately decide for option 1, then I think closing out this PR and tracking work elsewhere would be the next best move. Either way, my goal is to just make things clearer for future contributors ❤️ I'd like to await at least one more member of the @primer/design-systems team for their opinion before making any further changes. ✌️ |
|
@francisfuzz let's move ahead with option 2 😁 |
| ### Components | ||
|
|
||
| [Components](/css/components) are frequently used visual patterns we've abstracted into a set of convenient styles, that would be otherwise difficult to achieve with utilities and layout objects. | ||
|
|
||
| Making a decision on whether new components should be added is done on a case by case basis. It's not always easy to make that decision but here are some questions you should ask yourself before moving forward with a pull request. The design systems team will help you make this decision. | ||
| Making a decision on whether new components should be added is done on a case by case basis. It's not always easy to make that decision but here are some questions you should ask yourself before moving forward with a pull request. |
There was a problem hiding this comment.
This whole paragraph is pretty cringe. How about this:
| Making a decision on whether new components should be added is done on a case by case basis. It's not always easy to make that decision but here are some questions you should ask yourself before moving forward with a pull request. | |
| Decisions to add new components are made on a case-by-case basis, with help from the GitHub Design Systems team. Some questions that we use to guide these decisions include: |
| @@ -39,7 +41,7 @@ Many of the same questions can be applied to objects and utilities, however the | |||
|
|
|||
| It's usually better to open an issue before investing time in spiking out a new pattern. This gives the design systems team a heads up and allows other designers to share thoughts. Here's an outline of what's helpful to include in a new style issue: | |||
|
|
|||
| 1. What the pattern is and how it's being used across the site - post screenshots and urls where possible. If you need help identifying where the pattern is being used, call that out here and cc the relevant team and/or cc `@product-design` to help. | |||
| 1. What the pattern is and how it's being used across the site - post screenshots and urls where possible. If you need help identifying where the pattern is being used, call that out in the issue. | |||
There was a problem hiding this comment.
I like your change. Let's fix up some of the other language in this item while we're in there:
| 1. What the pattern is and how it's being used across the site - post screenshots and urls where possible. If you need help identifying where the pattern is being used, call that out in the issue. | |
| 1. What the pattern is, and how it's being used on GitHub.com. Post screenshots and/or URLs whenever possible. If you need help identifying where the pattern is used, call that out in the issue. |
There was a problem hiding this comment.
Hmmm.. It won't let me accept the suggestions:
I guess the forked repo is locked for maintainer changes? 🤔 I made a new PR #1000 that includes the suggestions.
@francisfuzz thanks for contributing to the contributions guidelines. 😁 ❤️
This PR updates the repo's contributing guide for a general audience.
Fixes #940.
I'm interested in reducing confusion for first-time and existing contributors who happen to come across this guide. 😎
/cc @primer/ds-core