You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[NO_TICKET] Update backstop files and misc linting changes (#698)
* Move backstop reference files to packages/design-system-docs/__tests, and move other backstop files to tmp
* Update reference files
* Update lint script to include root
Co-authored-by: Scott Weber <[email protected]>
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+14-17
Original file line number
Diff line number
Diff line change
@@ -9,16 +9,17 @@ Please take a look at our [Code of Conduct](CODE_OF_CONDUCT.md) to learn more.
9
9
10
10
If you are interested in running this site locally, please take a look at [setting up your local development environment](/README.md#running-locally).
11
11
12
-
Use [our guides](https://github.com/CMSgov/design-system/tree/master/guides) to find additional information like:
13
-
* Guiding principles
14
-
* Coding guidelines
15
-
* How to write documentation
12
+
Use [our guides](https://github.com/CMSgov/design-system/tree/master/guides) to find additional information like:
13
+
14
+
- Guiding principles
15
+
- Coding guidelines
16
+
- How to write documentation
16
17
17
18
## Submitting a pull request
18
19
19
-
*[Fork the design system](https://guides.github.com/activities/forking/) into your GitHub account
20
-
*[Create a branch](https://help.github.com/en/articles/creating-and-deleting-branches-within-your-repository) from `master` that defines what you’re working on (for example, fix-autocomplete-bug).
21
-
*[Submit a pull request](https://help.github.com/en/articles/creating-a-pull-request) against the `master` branch
20
+
-[Fork the design system](https://guides.github.com/activities/forking/) into your GitHub account
21
+
-[Create a branch](https://help.github.com/en/articles/creating-and-deleting-branches-within-your-repository) from `master` that defines what you’re working on (for example, fix-autocomplete-bug).
22
+
-[Submit a pull request](https://help.github.com/en/articles/creating-a-pull-request) against the `master` branch
22
23
23
24
**Note:** more information on the [GitHub flow](https://guides.github.com/introduction/flow/)
24
25
@@ -47,7 +48,6 @@ Open a new [GitHub issue](https://github.com/CMSgov/design-system/issues/new?ass
47
48
- Can this serve more than one use case and be reusable in multiple scenarios? Please explain.
48
49
- Please include links to any examples, research or code to support your proposal, if available.
49
50
50
-
51
51
### Step 2 - Review (Core design system team)
52
52
53
53
After an idea is proposed, it undergoes an evaluation by a team member. This review is to determine whether the contribution needs small fixes, visual improvements, or whether to reject it.
@@ -56,14 +56,13 @@ During this stage, the team will review supporting research — and link this re
56
56
57
57
Revisions may be requested before moving the proposal to Draft. If the proposal is good to go as is, it's moved to Draft. If the proposal doesn’t pass the evaluation, the reviewer will reject it and close the issue.
58
58
59
-
60
59
The criteria used in evaluating is:
61
60
62
-
-**Usability**: Is the pattern responsive? Is the interaction flow clearly documented?
61
+
-**Usability**: Is the pattern responsive? Is the interaction flow clearly documented?
63
62
-**Accessibility**: Is the pattern 508 compliant and accessible?
64
63
-**Visual design**: Is the pattern consistent with the CMS Design system visual style?
65
64
66
-
The pattern will be marked as *Draft* when it passes evaluation criteria.
65
+
The pattern will be marked as _Draft_ when it passes evaluation criteria.
67
66
68
67
### Step 3 - Draft (Core design system team)
69
68
@@ -76,14 +75,11 @@ Acceptance criteria:
76
75
- Pattern validates against accessibility criteria
77
76
- Feedback has been collected on the pattern based on usage in real-world products and revised if necessary
78
77
79
-
80
-
Finally, a team member will either move the pattern to *Ready*; ask for revisions; or, in some cases, reject the pattern.
81
-
78
+
Finally, a team member will either move the pattern to _Ready_; ask for revisions; or, in some cases, reject the pattern.
82
79
83
80
### Step 4 - Ready
84
81
85
-
When a pattern is moved to *Ready*, all criteria from the Draft step have been completed. The pattern is now a stable part of the design system in production and the core team will conduct ongoing maintenance (bug fixes, minor enhancements, and so on).
86
-
82
+
When a pattern is moved to _Ready_, all criteria from the Draft step have been completed. The pattern is now a stable part of the design system in production and the core team will conduct ongoing maintenance (bug fixes, minor enhancements, and so on).
87
83
88
84
## Amending patterns
89
85
@@ -95,7 +91,7 @@ Amendment proposals should follow the same process as outlined above. During the
95
91
96
92
As technology changes, certain UI patterns will become less relevant or may be replaced by better patterns. As we become aware of such changes, we’ll remove patterns from the library. To avoid pulling the rug out from under people relying on those patterns in their projects, deprecated patterns will remain within the codebase for at least a month after deprecation. The patterns will also be marked as deprecated in the documentation and in the developer's console when used in a project.
97
93
98
-
----
94
+
---
99
95
100
96
## Licenses and attribution
101
97
@@ -104,6 +100,7 @@ A few parts of this project are not in the public domain. Attribution and licens
104
100
The rest of this project is in the worldwide public domain, released under the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
105
101
106
102
## Contributions
103
+
107
104
All contributions to this project will be released under the CC0 dedication alongside the public domain portions of this project. For more information, see [CONTRIBUTING.md](CONTRIBUTING.md).
Copy file name to clipboardexpand all lines: LICENSE.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -59,4 +59,4 @@ Unless expressly stated otherwise, the person who associated a work with this de
59
59
60
60
### Contributions to this project
61
61
62
-
As stated in [CONTRIBUTING](CONTRIBUTING.md), all contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
62
+
As stated in [CONTRIBUTING](CONTRIBUTING.md), all contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
0 commit comments