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
Copy file name to clipboardExpand all lines: docs/content/getting-started/contributing.md
-47Lines changed: 0 additions & 47 deletions
Original file line number
Diff line number
Diff line change
@@ -71,52 +71,6 @@ If you get to this step you've helped contribute to a style guide that many of y
71
71
[Please open an issue](#step-1-open-an-issue) if we can improve these guidelines and make following this process any easier.
72
72
73
73
74
-
## Removing styles and variables
75
-
76
-
Removing styles and SCSS variables can be scary. How do you know if the thing you're deleting (or just planning to delete) isn't used in other projects? [Semantic versioning] provides us with an answer: We **don't** know, but we can use "major" version increments (from, say, `13.4.0` to `14.0.0`) to signal that the release includes potentially breaking changes. The rule is simple:
77
-
78
-
**Whenever we delete a CSS selector or SCSS variable, we will increment to the next major version.**
79
-
80
-
When planning to delete a CSS selector or SCSS variable, you should:
81
-
82
-
1. Add a [TODO@version comment](#primer-csstodo) above the line in question:
message: '$some-unused-var is unused, and has been deprecated.'
97
-
}
98
-
]
99
-
}
100
-
```
101
-
102
-
We have several checks and tools in place to help us plan, track, and catch both expected and unexpected removals of both CSS selectors and SCSS variables:
103
-
104
-
### `deprecations.js`
105
-
[This file][deprecations.js] is where we document all of our current and _planned_ CSS selector and SCSS variable deprecations (removals), and is used to generate [deprecation data](../tools/deprecations) for other tools.
106
-
107
-
### `primer-css/TODO`
108
-
[This stylelint rule][script/stylelint-todo.js] looks for comments in the form:
109
-
110
-
```scss
111
-
// TODO@<version>: <message>
112
-
```
113
-
114
-
and generates an error for each one whose `<version>` is less than or equal to the current version (in `package.json`).
115
-
116
-
Where `<version>` is the future version you'd like to compare against. Assuming that the correctly formatted comments exist already, violations of this stylelint rule can be used to generate a checklist of lines to remove in a future release.
117
-
118
-
See [the deprecation data docs](../tools/deprecations) for more information.
119
-
120
74
## Documentation structure
121
75
122
76
- Our documentation site for Primer CSS is built using [Doctocat](https://primer.style/doctocat) and deployed with [Now](https://zeit.co/now). Our site is built from the `docs` folder and uses [MDX](https://mdxjs.com) to render markdown.
@@ -154,4 +108,3 @@ To understand what choice to make, you'll need to understand semver and know if
0 commit comments