Add writing changeset guidelines (#648)
* Add writing changeset guidelines * Update PULL_REQUEST_TEMPLATE.md
This commit is contained in:
parent
426552ded0
commit
3aafc9fe72
2 changed files with 63 additions and 8 deletions
|
@ -1,8 +1,62 @@
|
||||||
# Changesets
|
# Changeset
|
||||||
|
|
||||||
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
|
## Writing guidelines
|
||||||
with multi-package repos, or single-package repos to help you version and publish your code. You can
|
|
||||||
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
|
|
||||||
|
|
||||||
We have a quick list of common questions to get you started engaging with this project in
|
### Rules:
|
||||||
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
|
|
||||||
|
#### 1. Avoid repetition when describing bug fixes
|
||||||
|
|
||||||
|
Bad:
|
||||||
|
|
||||||
|
> Fixed a bug where the component fired confetti uncontrollably when typing into the input. Fixed a bug when...
|
||||||
|
|
||||||
|
Good:
|
||||||
|
|
||||||
|
> The input no longer fires confetti on typing.
|
||||||
|
|
||||||
|
#### 2. Use more personal tone
|
||||||
|
|
||||||
|
Bad:
|
||||||
|
|
||||||
|
> It is now possible to use the class xyz directly in…
|
||||||
|
|
||||||
|
Good:
|
||||||
|
|
||||||
|
> **You can now** use the class xyz directly in…
|
||||||
|
|
||||||
|
#### 3. Make it about the user, not the code
|
||||||
|
|
||||||
|
Bad:
|
||||||
|
|
||||||
|
> Added the X and Y fields to the schema returned by Z.
|
||||||
|
|
||||||
|
Good:
|
||||||
|
|
||||||
|
> You can now see how many users are connected to a deployment (*X*), and the users capacity of the deployment (*Y*).
|
||||||
|
|
||||||
|
#### 4. Use a minimal amount of fluff
|
||||||
|
|
||||||
|
Bad:
|
||||||
|
|
||||||
|
> After many long nights at the office, several cans of beer, and consuming the amount of pizza equal to the surface of a helipad, we finally managed to squash a bug that’s been haunting you forever. Its origin reaches back to the times when Tim Berners-Lee…
|
||||||
|
|
||||||
|
Good:
|
||||||
|
|
||||||
|
> The application no longer shuts down when attempting to abort a payment.
|
||||||
|
|
||||||
|
#### 5. Use a template when lost
|
||||||
|
|
||||||
|
If you don’t have an idea how to start, you may use some of those openings:
|
||||||
|
|
||||||
|
- “You can now…”
|
||||||
|
- “X no longer does Y when Z.”
|
||||||
|
- “X no longer does Y. This means you no longer need to Z.”
|
||||||
|
|
||||||
|
#### 6. Describe known issues
|
||||||
|
|
||||||
|
When the release introduces some issues or limitations, describe them:
|
||||||
|
|
||||||
|
> You may experience issues when trying to use the new view with an adblocker turned on. The issue will be fixed in the next release. For now, please…
|
||||||
|
|
||||||
|
### Resources
|
||||||
|
- https://www.youtube.com/watch?v=L3yAD319DiU&source_ve_path=MjM4NTE
|
||||||
|
|
5
.github/PULL_REQUEST_TEMPLATE.md
vendored
5
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -1,2 +1,3 @@
|
||||||
# Impact
|
## Checklist
|
||||||
* [ ] .github/dependabot.yaml is up-to date.
|
* [ ] `.github/dependabot.yaml` is up-to date.
|
||||||
|
* [ ] I added changesets and [read good practices](/.changeset/README.md).
|
||||||
|
|
Loading…
Reference in a new issue