Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update contributing guide for a general audience #941

Closed
wants to merge 4 commits into from
Closed

Update contributing guide for a general audience #941

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
90d8e2d
docs/content/getting-started/contributing.md: remove reference to @pr…
francisfuzz Oct 11, 2019
343ee3f
docs/content/getting-started/contributing.md: remove reference to #de…
francisfuzz Oct 11, 2019
1e8965f
docs/content/getting-started/contributing.md: remove references to in…
francisfuzz Oct 11, 2019
dbddea0
Update contributing.md
francisfuzz Nov 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs/content/getting-started/contributing.md: remove references to in… 
…ternal team
  • Loading branch information
@francisfuzz
francisfuzz committed Oct 11, 2019
commit 1e8965fd0ede68ad41f3f4c804a1b693f6d6ff2e
4 changes: 2 additions & 2 deletions docs/content/getting-started/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Guidelines for contributing to GitHub's CSS

[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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole paragraph is pretty cringe. How about this:

Suggested change
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:


- How often is this pattern used across the site?
- Could these styles be achieved with existing components, objects, and utilities?
Expand Down Expand Up @@ -62,7 +62,7 @@ New styles we add should be used in as many places as makes sense to in producti

If you get to this step you've helped contribute to a style guide that many of your colleagues use on a daily basis, you've contributed to an open source project that's referenced and used by many others, and you've helped improve the usability and consistency of GitHub for our users. Thank you!

Let the [design systems team](https://github.com/github/design-systems) know if we can improve these guidelines and make following this process any easier.
[Please open an issue](#step-1-open-an-issue) if we can improve these guidelines and make following this process any easier.

## Documentation structure

Expand Down