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: .github/CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
[fork]: https://github.com/github/primer/fork
4
4
[pr]: https://github.com/github/primer/compare
5
-
[style]: http://primercss.io/guidelines/
5
+
[style]: http://primer.github.io/guidelines/
6
6
7
7
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
8
8
@@ -59,16 +59,16 @@ Good pull requests—patches, improvements, new features—are a fantastic help.
59
59
60
60
### Updating Primer modules
61
61
62
-
Anyone can open a pull request on Primer CSS. You do not need to work at GitHub or be a member of the org to open a pull request.
62
+
Anyone can open a pull request on Primer. You do not need to work at GitHub or be a member of the org to open a pull request.
63
63
64
-
1. Fork and clone [this repository](https://github.com/primer/primer-css).
64
+
1. Fork and clone [this repository](https://github.com/primer/primer).
65
65
2. Configure and install the dependencies: `npm install`
66
66
3. Check out the dev branch `git checkout dev`
67
67
3. Create a new branch from dev `git checkout -b my-branch-name`
68
68
4. Make your changes and commit them.
69
69
5. Push your branch and open a pull request against `dev`. Add a comment describing your proposed changes and request a review from `@primer/ds-core`.
70
70
6. Wait for CI tests to finish.
71
-
- If the tests pass, you should see a status check telling you which alpha version of primer-css you can install with npm to test your work in other projects.
71
+
- If the tests pass, you should see a status check telling you which alpha version of primer you can install with npm to test your work in other projects.
72
72
- If the tests fail, review the logs and address any issues.
73
73
- If the builds fail for any other reason (as they occasionally do), they may need to be manually restarted.
74
74
7. When CI tests pass, a new npm alpha release will be posted under the CI checks, you can use this npm version for testing in your project or with a GitHub site if you are staff.
*[#359](https://github.com/primer/primer-css/pull/359) Change markdown li break to handle Safari 10.x user stylesheet bug. ([@feministy](https://github.com/feministy))
*[#307](https://github.com/primer/primer-css/pull/307) Do not suppress opacity transition for tooltipped-no-delay. ([@astorije](https://github.com/astorije))
*[#390](https://github.com/primer/primer-css/pull/390) Updating storiesFromMarkdown to read in rails octicons helper and replace with react component. ([@jonrohan](https://github.com/jonrohan))
25
+
*[#389](https://github.com/primer/primer-css/pull/389) Publish alpha release any time we're not on a release branch or master. ([@jonrohan](https://github.com/jonrohan))
26
+
*[#384](https://github.com/primer/primer-css/pull/384) Adding a test to check for the current year in the license and source…. ([@jonrohan](https://github.com/jonrohan))
- Add deprecation warnings for `primer-cards` and `primer-forms/lib/form-validation.scss`#347 (these will be removed in v10.0.0)
25
68
26
69
### Changes
27
-
- Update npm metadata for `primer-css`, `primer-core`, `primer-product`, and `primer-marketing`#328
70
+
- Update npm metadata for `primer`, `primer-core`, `primer-product`, and `primer-marketing`#328
28
71
- Remove `HEAD` heading from the changelog #327
29
72
30
73
# 9.3.0
@@ -36,7 +79,7 @@
36
79
## Changes
37
80
- Removes `docs` from `gitignore`
38
81
- Removes the `^` from all dependencies so that we can publish exact versions
39
-
- Consolidates release notes from various sources into one changelog located in `/modules/primer-css/CHANGELOG.md`
82
+
- Consolidates release notes from various sources into one changelog located in `/modules/primer/CHANGELOG.md`
40
83
41
84
# 9.2.0
42
85
@@ -47,7 +90,7 @@
47
90
## Changes
48
91
49
92
- Remove per-module configurations (`.gitignore`, `.postcss.json`, `.stylelintrc.json`) and `CHANGELOG.md` files in #284
50
-
- Replace most static `font-size`, `font-weight`, and `line-height` CSS property values with their [SCSS variable equivalents](https://github.com/primer/primer-css/blob/c9ea37316fbb73c4d9931c52b42bc197260c0bf6/modules/primer-support/lib/variables/typography.scss#L12-L33) in #252
93
+
- Replace most static `font-size`, `font-weight`, and `line-height` CSS property values with their [SCSS variable equivalents](https://github.com/primer/primer/blob/c9ea37316fbb73c4d9931c52b42bc197260c0bf6/modules/primer-support/lib/variables/typography.scss#L12-L33) in #252
51
94
- Refactor CI scripts to use Travis conditional deployment for release candidate and final release publish steps in #290
52
95
53
96
# 9.1.1
@@ -94,7 +137,7 @@ This release also includes major improvements to our Travis build scripts to aut
94
137
95
138
We discovered that `primer-core` specified and outdated version of `primer-base` in it's dependencies. The outdated version did not have `normalize.scss` included which could cause some issues. This has issue occurred during v7.0.0 when creating the new monorepo. Also fixes repo urls in `package.json` for individual packages.
96
139
97
-
See PR [#243](https://github.com/primer/primer-css/pull/243)
140
+
See PR [#243](https://github.com/primer/primer/pull/243)
98
141
99
142
## Changes
100
143
@@ -139,7 +182,7 @@ See PR [#243](https://github.com/primer/primer-css/pull/243)
139
182
140
183
# 8.0.0 - Imports
141
184
142
-
Fixes issues with the ordering of imports in each of our meta-packages. See PR [#239](https://github.com/primer/primer-css/pull/239)
185
+
Fixes issues with the ordering of imports in each of our meta-packages. See PR [#239](https://github.com/primer/primer/pull/239)
143
186
144
187
145
188
## Changes
@@ -155,7 +198,7 @@ Fixes issues with the ordering of imports in each of our meta-packages. See PR [
155
198
156
199
# 7.0.0 - Monorepo
157
200
158
-
In an effort to improve our publishing workflow we turned Primer CSS into a monorepo, made this repo the source of truth for Primer by removing Primer modules from GitHub, and setup Lerna for managing multiple packages and maintaining independent versioning for all our modules.
201
+
In an effort to improve our publishing workflow we turned Primer into a monorepo, made this repo the source of truth for Primer by removing Primer modules from GitHub, and setup Lerna for managing multiple packages and maintaining independent versioning for all our modules.
159
202
160
203
This is exciting because:
161
204
@@ -164,7 +207,7 @@ This is exciting because:
164
207
- we no longer have files like package.json, scripts, and readme's in the GitHub app that don't really belong there
165
208
-**we can accept pull requests from external contributors** again!
166
209
167
-
See PR for more details on this change: https://github.com/primer/primer-css/pull/230
210
+
See PR for more details on this change: https://github.com/primer/primer/pull/230
Primer is the CSS framework that powers GitHub's front-end design. Primer CSS includes 23 packages that are grouped into 3 core meta-packages for easy install. Each package and meta-package is independently versioned and distributed via npm, so it's easy to include all or part of Primer within your own project.
6
+
Primer is the design system that powers GitHub. Primer includes 23 packages that are grouped into 3 core meta-packages for easy install. Each package and meta-package is independently versioned and distributed via npm, so it's easy to include all or part of Primer within your own project.
7
7
8
8
## Packages
9
9
10
-
The Primer CSS repo is managed as a monorepo that is composed of many npm packages.
10
+
The Primer repo is managed as a monorepo that is composed of many npm packages.
11
11
12
12
### Core Packages
13
13
14
14
| Package | Version |
15
15
|---|---|
16
-
|**[primer-css](/modules/primer-css)** <br />Includes all 23 packages |[](https://www.npmjs.com/package/primer-css)|
16
+
|**[primer](/modules/primer)** <br />Includes all 23 packages |[](https://www.npmjs.com/package/primer)|
This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `primer-css` with this command.
23
+
This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `primer` with this command.
24
24
25
25
```sh
26
-
$ npm install --save primer-css
26
+
$ npm install --save primer
27
27
```
28
28
29
29
## Usage
30
30
31
31
The source files included are written in [Sass][sass] (SCSS). After [installing](#install) with npm, you can add your project's `node_modules` directory to your Sass [include paths](https://github.com/sass/node-sass#includepaths) (AKA [load paths](http://technology.customink.com/blog/2014/10/09/understanding-and-using-sass-load-paths/) in Ruby), then import it like this:
32
32
33
33
```scss
34
-
@import"primer-css/index.scss";
34
+
@import"primer/index.scss";
35
35
```
36
36
37
37
You can import individual Primer modules by installing them with npm, for instance:
@@ -46,10 +46,10 @@ Then, you would import the module with:
46
46
@import"primer-navigation/index.scss";
47
47
```
48
48
49
-
Or, while you're figuring out which modules you need, you can import them directly from the `primer-css`[`packages` directory](./packages) like so:
49
+
Or, while you're figuring out which modules you need, you can import them directly from the `primer`[`packages` directory](./packages) like so:
0 commit comments