Skip to content

Commit 64d9ab6

Browse files
authored
Update contributing.md with changeset instruction (#3293)
* update contributing.md with changeset instruction * Create twelve-pets-joke.md
1 parent a391c3b commit 64d9ab6

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

.changeset/twelve-pets-joke.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
3+
---

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,40 @@ Before you start working on a larger contribution, you should get in touch with
9797
```
9898

9999
* In GitHub, send a pull request to `firebase-js-sdk:master`.
100+
* Add changeset. See [Adding changeset to PR](#adding-changeset-to-pr)
100101
* All pull requests must be reviewed by a member of the Firebase JS SDK team, who will merge it when/if they feel it is good to go.
101102

102103
That's it! Thank you for your contribution!
103104
105+
#### Adding changeset to PR
106+
Every PR that would trigger a release should include a changeset file. To make
107+
this process easy, a message will be sent to every PR with a link that you can
108+
click to add changeset files in the Github UI directly.
109+
[Example message](https://github.com/firebase/firebase-js-sdk/pull/3284#issuecomment-649718617).
110+
111+
#### What to include in the changset file
112+
113+
You should include the version bump for your package as well as the description
114+
for the change. Valid version bump types are `patch`, `minor` and `major`.
115+
Please always include the `firebase` package with the same version bump type as
116+
your package. This is to ensure that the version of the `firebase` package will
117+
be bumped correctly. For example,
118+
119+
```
120+
---
121+
"@firebase/storage": minor
122+
"firebase": minor
123+
---
124+
125+
This is a test.
126+
```
127+
128+
#### Multiple changeset files
129+
130+
If your PR touches multiple SDKs or addresses multiple issues that require
131+
different version bump or different description, you can create multiple
132+
changeset files in the PR.
133+
104134
## <a name="docs"></a> Updating Documentation
105135
106136
Reference docs for the Firebase [JS SDK](https://firebase.google.com/docs/reference/js/) and [Node (client) SDK](https://firebase.google.com/docs/reference/node/) are generated by [Typedoc](https://typedoc.org/).

0 commit comments

Comments
 (0)