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: README.md
+19-22Lines changed: 19 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -155,48 +155,45 @@ the root of the monorepo.
155
155
156
156
### Submit a changeset
157
157
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:
159
163
160
164
```bash
161
165
npm run changeset
162
166
```
163
167
164
168
After which follow the command prompts to select which packages and which version each package should receive.
165
169
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.
169
171
170
-
```bash
171
-
npm version
172
-
```
172
+
## Publishing
173
173
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.
175
176
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.
179
181
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.
181
185
182
-
###I disagree with a specific rule
186
+
## I disagree with a specific rule
183
187
184
188
Great. We'd love to talk about it. Fork this repository and submit a pull-request.
185
189
186
-
###Help! It's not working for me
190
+
## Help! It's not working for me
187
191
188
192
No problem. Reach out to us by [opening an issue]
189
193
190
194
## Roadmap
191
195
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))
200
197
201
198
[opening an issue]: https://github.com/godaddy/javascript/issues
0 commit comments