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
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
8
8
@@ -12,21 +12,20 @@ The issue tracker is the preferred channel for [bug reports](#bug-reports), [fea
12
12
13
13
* Please **do not** use the issue tracker for personal support requests.
14
14
* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.
15
-
* Please **do not** open issues or pull requests regarding the code in [`Normalize`](https://github.com/necolas/normalize.css) (open them in their respective repositories).
16
15
17
16
## Bug reports
18
17
19
18
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!
20
19
21
20
Guidelines for bug reports:
22
21
23
-
0.**Validate and lint your code**—[validate your HTML](http://html5.validator.nu) to ensure your problem isn't caused by a simple error in your own code.
22
+
1.**Validate and lint your code**—[validate your HTML](http://html5.validator.nu) to ensure your problem isn't caused by a simple error in your own code.
24
23
25
-
1.**Use the GitHub issue search**— check if the issue has already been reported.
24
+
2.**Use the GitHub issue search**— check if the issue has already been reported.
26
25
27
-
2.**Check if the issue has been fixed**— try to reproduce it using the latest `master` or development branch in the repository.
26
+
3.**Check if the issue has been fixed**— try to reproduce it using the latest `master` branch in the repository.
28
27
29
-
3.**Isolate the problem**— ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example.
28
+
4.**Isolate the problem**— ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example.
30
29
31
30
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
32
31
@@ -61,10 +60,9 @@ Anyone can open a pull request on Primer. You do not need to work at GitHub or b
61
60
62
61
1. Fork and clone [this repository](https://github.com/primer/primer).
63
62
2. Configure and install the dependencies: `npm install`
64
-
3. Check out the dev branch `git checkout dev`
65
-
3. Create a new branch from dev `git checkout -b my-branch-name`
63
+
3. Create a new branch from master `git checkout -b my-branch-name`
66
64
4. Make your changes and commit them.
67
-
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`.
65
+
5. Push your branch and open a pull request. Add a comment describing your proposed changes and request a review from `@primer/ds-core`.
68
66
6. Wait for CI tests to finish.
69
67
- 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.
70
68
- If the tests fail, review the logs and address any issues.
@@ -77,6 +75,111 @@ Here are a few things you can do that will increase the likelihood of your pull
77
75
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
78
76
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
79
77
78
+
## Releasing a new Primer version 🎉
79
+
80
+
This section is targeted at maintainers of primer, to instruct them on the processes for releasing a new version.
81
+
82
+
### In `primer/primer`:
83
+
84
+
1. Find or create a new pull request with a release branch from `master` and name it `release-<version>`.
85
+
86
+
(CI will publish a release candidate version to npm for branches prefixed with `release`. These version numbers have a `rc.<number>` suffix on them)
87
+
88
+
For the pull request you can use the following template.
89
+
90
+
```md
91
+
# Primer Minor Release
92
+
93
+
Tracking Issue for next release: 📦 **0.0.0**
94
+
Approximate release date: 📆
95
+
96
+
### Must
97
+
98
+
- [ ]
99
+
100
+
### Should
101
+
102
+
- [ ]
103
+
104
+
### Could
105
+
106
+
- [ ]
107
+
108
+
----
109
+
110
+
### Ship checklist
111
+
112
+
- [ ] Update CHANGELOG
113
+
- [ ] Run version bump
114
+
- [ ] Update primer.github.io
115
+
- [ ] Update github/github
116
+
- [ ] Update the style guide
117
+
- [ ] Update the release tag note
118
+
- [ ] Create a new pull request for the next release
119
+
120
+
/cc @primer/ds-core
121
+
```
122
+
123
+
2. Go through the tracking issue and make sure everything that should be merged in is merged in.
124
+
125
+
3. Once your builds finish, click on the details links for the continuous-integration/travis-ci/push build. Expand the `Deploying application` output and you should be able to find an outputted change log here. Copy this and update the [CHANGELOG.md](https://github.com/primer/primer/blob/master/CHANGELOG.md) file.
126
+
127
+
4. Run the version bump in your terminal: `npm run bump`.
128
+
129
+
5. Test your changes with the latest release candidate version in the appropriate places (styleguide, storybook, github/github).
130
+
131
+
6. Once the release PR is approved and you've done necessary testing, merge to `master`. This will trigger a publish to npm.
132
+
133
+
### In `github/github`:
134
+
135
+
1. Create a new branch
136
+
137
+
2. Update the primer version in your terminal `bin/npm install primer@<version>`.
138
+
139
+
3. Update `stylelint-config-primer` in your terminal to the appropriate version `bin/npm install stylelint-config-primer@latest`.
140
+
141
+
4. If you need to make changes to github/github due to the Primer release, make a separate branch. When ready, merge that branch into your release branch.
142
+
143
+
5. Add reviewers.
144
+
145
+
6. Check that every deleted vendor file has an accompanying updated vendor file and that the version numbers look correct.
146
+
147
+
7. Test on review-lab.
148
+
149
+
8. When ready, merge! 🎉
150
+
151
+
152
+
## Other items that need to be done after publishing Primer
153
+
154
+
#### Update the Style Guide
155
+
156
+
1. In [github/styleguide](https://github.com/github/styleguide), update `primer` to your newly released version in your terminal:
157
+
158
+
`npm install primer@latest`
159
+
160
+
2. Then run: `script/update-primer-docs`.
161
+
162
+
3. Commit changes, make PR, get it approved, merge! 🚀
163
+
164
+
#### Update [primer.github.io](primer.github.io)
165
+
166
+
1. Edit [index.html](https://github.com/primer/primer.github.io/blob/master/index.html) to include the latest version.
167
+
168
+
#### Update Storybook
169
+
170
+
1. Pull the latest from master on primer/primer (after merging in release branch).
171
+
172
+
2. Run `npm run publish-storybook`.
173
+
174
+
#### Publish release tag
175
+
176
+
1. Create a new release tag [here](https://github.com/primer/primer/releases/new).
177
+
178
+
2. Copy the changes from the [CHANGELOG](https://github.com/primer/primer/blob/master/CHANGELOG.md) and paste it into the release notes.
179
+
180
+
3. Publish 🎉
181
+
182
+
80
183
## Resources
81
184
82
185
-[Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
Copy file name to clipboardExpand all lines: CHANGELOG.md
+24-1Lines changed: 24 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,27 @@
1
-
## 10.6.1
1
+
# 10.7.0
2
+
3
+
#### :nail_care: Polish
4
+
*[#511](https://github.com/primer/primer/pull/511) change double quotes to single quotes in Avatar stack stories. ([@AustinPaquette](https://github.com/AustinPaquette))
- Jon Rohan ([jonrohan](https://github.com/jonrohan))
22
+
- Shawn Allen ([shawnbot](https://github.com/shawnbot))
23
+
24
+
# 10.6.1
2
25
3
26
#### :bug: Bug Fix
4
27
*[#506](https://github.com/primer/primer/pull/506) Fix white border on last avatar in AvatarStack (take two). ([@shawnbot](https://github.com/shawnbot))
Copy file name to clipboardExpand all lines: RELEASING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,9 @@
22
22
23
23
1. Create a new branch
24
24
25
-
2. Update the primer version in your terminal `npm install primer@<version>`.
25
+
2. Update the primer version in your terminal `bin/npm install primer@<version>`.
26
26
27
-
3. Update `stylelint-config-primer` in your terminal to the appropriate version `npm install stylelint-config-primer@latest`.
27
+
3. Update `stylelint-config-primer` in your terminal to the appropriate version `bin/npm install stylelint-config-primer@latest`.
28
28
29
29
4. If you need to make changes to github/github due to the Primer release, make a separate branch. When ready, merge that branch into your release branch.
0 commit comments