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: CONTRIBUTING.md
+3-73Lines changed: 3 additions & 73 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -155,79 +155,9 @@ You can use Gitpod (An Online Open Source VS Code like IDE which is free for Ope
155
155
156
156
[](https://gitpod.io/#https://github.com/TanStack/query)
157
157
158
-
## Commit message conventions
158
+
## Changesets
159
159
160
-
`TanStack/query` is using [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).
161
-
162
-
We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**.
163
-
164
-
### Commit Message Format
165
-
166
-
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
167
-
format that includes a **type**, a **scope** and a **subject**:
168
-
169
-
```text
170
-
<type>(<scope>): <subject>
171
-
<BLANK LINE>
172
-
<body>
173
-
<BLANK LINE>
174
-
<footer>
175
-
```
176
-
177
-
The **header** is mandatory and the **scope** of the header is optional.
178
-
179
-
Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
180
-
181
-
### Type
182
-
183
-
Must be one of the following:
184
-
185
-
- **feat**: A new feature
186
-
- **fix**: A bug fix
187
-
- **docs**: Documentation only changes
188
-
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
189
-
- **refactor**: A code change that neither fixes a bug nor adds a feature
190
-
- **perf**: A code change that improves performance
191
-
- **test**: Adding missing or correcting existing tests
192
-
- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
193
-
194
-
### Scope
195
-
196
-
The scope could be anything specifying place of the commit change. For example `query-core`, `react-query` etc...
197
-
198
-
You can use `*` when the change affects more than a single scope.
199
-
200
-
### Subject
201
-
202
-
The subject contains succinct description of the change:
203
-
204
-
- use the imperative, present tense: "change" not "changed" nor "changes"
205
-
- don't capitalize first letter
206
-
- no dot (.) at the end
207
-
208
-
### Body
209
-
210
-
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
211
-
212
-
### Footer
213
-
214
-
The footer should contain any information about **Breaking Changes** and is also the place to [reference GitHub issues that this commit closes](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue).
215
-
216
-
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
217
-
218
-
### Example
219
-
220
-
Here is an example of the release type that will be done based on a commit messages:
| perf(pencil): remove `graphiteWidth` option<br/><br/>BREAKING CHANGE: The `graphiteWidth` option has been removed.<br/>The default graphite width of 10mm is always used for performance reasons. |~~Major~~ Breaking Release |
227
-
228
-
### Revert
229
-
230
-
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
160
+
This repo uses [Changesets](https://github.com/changesets/changesets) to automate releases. If your PR should release a new package version (patch, minor, or major), please run run `pnpm changeset` and commit the file. If needed, changeset descriptions can be more descriptive, and will be included in the changelog. If your PR affects docs, examples, styles, etc., you probably don't need to generate a changeset.
231
161
232
162
## Pull requests
233
163
@@ -237,7 +167,7 @@ Use an appropriate commit type. Be especially careful with breaking changes.
237
167
238
168
## Releases
239
169
240
-
For each new commit added to `main` with `git push` or by merging a pull request or merging from another branch, a GitHub action is triggered and runs the `semantic-release`command to make a release if there are codebase changes since the last release that affect the package functionalities.
170
+
For each new commit added to `main`, a GitHub Workflow is triggered which runs the [Changesets Action](https://github.com/changesets/action). This generates a preview PR showing the impact of all changesets. When this PR is merged, the package will be published to NPM.
0 commit comments