Skip to content

Commit 68edbd6

Browse files
Update contributing and publishing steps (#735)
* docs: update contribution/publishing steps * docs: update contribution/publishing steps
1 parent c093823 commit 68edbd6

File tree

2 files changed

+24
-25
lines changed

2 files changed

+24
-25
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@ Please provide enough information so that others can review your pull request. T
99
Explain the **motivation** for making this change. What existing problem does the pull request solve?
1010
-->
1111

12-
## Changelog
12+
## Changeset
1313

1414
<!--
15-
Help reviewers and the release process by writing your own changelog entry. See this project's CHANGELOG.md
16-
for an example.
15+
Help reviewers and the release process by included a changeset entry.
16+
Use `npm run changeset` and follow the prompts to create a changeset.
1717
-->
1818

19+
- [ ] Changeset added ([docs](https://github.com/godaddy/javascript#submit-a-changeset))
20+
1921
## Test Plan
2022

2123
<!--

README.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -155,48 +155,45 @@ the root of the monorepo.
155155

156156
### Submit a changeset
157157

158-
This repository utilizes [changesets] to handle versioning and publishing as you submit a pull-request. To initiate a changeset run:
158+
This repository utilizes [changesets] to handle versioning and publishing as you submit a pull-request.
159+
A changeset should be included with your pull-request to help the maintainers
160+
understand the changes and to help with the release process.
161+
162+
To initiate a changeset run:
159163

160164
```bash
161165
npm run changeset
162166
```
163167

164168
After which follow the command prompts to select which packages and which version each package should receive.
165169

166-
### Publishing
167-
168-
If you are lucky enough to get to publish a new version of a package you are in luck. This monorepo is setup to independently publish packages based on changes commited. Just make sure to run:
170+
Commit and push the changeset to your branch to be included with your pull-request.
169171

170-
```bash
171-
npm version
172-
```
172+
## Publishing
173173

174-
This will run `changeset version` and will update all packages to the versions based on the changesets committed into the `.changeset` directory. After the versioning is complete to handle publishing and creating a release run:
174+
When a pull-request is merged into the `main`, the changeset will be used
175+
to determine the next version of the package.
175176

176-
```bash
177-
npm run release
178-
```
177+
A "Version Packages" pull-request will be automatically created to bump the
178+
versions.
179+
If multiple PRs with changesets are merged, this PR will automatically update to
180+
include all changesets.
179181

180-
This runs `changeset publish` under the hood and handle as mentioned above.
182+
When all changes are ready to be published, repo admins can force squash merge
183+
the "Version Packages" PR to main (CI worflows do not run on this automated branch).
184+
This will trigger the CI to publish the packages to npm.
181185

182-
### I disagree with a specific rule
186+
## I disagree with a specific rule
183187

184188
Great. We'd love to talk about it. Fork this repository and submit a pull-request.
185189

186-
### Help! It's not working for me
190+
## Help! It's not working for me
187191

188192
No problem. Reach out to us by [opening an issue]
189193

190194
## Roadmap
191195

192-
- Consider other rules in an `eslint` only implementation:
193-
- `computed-property-spacing`
194-
- `generator-star-spacing`
195-
- `semi-spacing`
196-
- `block-spacing`
197-
- Continue to modularize the `eslint` rules.
198-
- Translate configuration files into more verbose written documentation.
199-
- Add support for IDE formats (IntelliJ, Webstorm, Atom, Eclipse, Sublime, etc...)
196+
- ESLint v9 support ([guide](https://eslint.org/docs/latest/use/migrate-to-9.0.0))
200197

201198
[opening an issue]: https://github.com/godaddy/javascript/issues
202199
[`eslint-config-godaddy`]: /packages/eslint-config-godaddy

0 commit comments

Comments
 (0)