Skip to content

Update contributing.md with changeset instruction #3293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 26, 2020
Merged

Update contributing.md with changeset instruction #3293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2cfa38
update contributing.md with changeset instruction
Feiyang1 Jun 25, 2020
2cbdc95
Create twelve-pets-joke.md
Feiyang1 Jun 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changeset/twelve-pets-joke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---

---
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,40 @@ Before you start working on a larger contribution, you should get in touch with
```

* In GitHub, send a pull request to `firebase-js-sdk:master`.
* Add changeset. See [Adding changeset to PR](#adding-changeset-to-pr)
* 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.

That's it! Thank you for your contribution!

#### Adding changeset to PR
Every PR that would trigger a release should include a changeset file. To make
this process easy, a message will be sent to every PR with a link that you can
click to add changeset files in the Github UI directly.
[Example message](https://github.com/firebase/firebase-js-sdk/pull/3284#issuecomment-649718617).

#### What to include in the changset file

You should include the version bump for your package as well as the description
for the change. Valid version bump types are `patch`, `minor` and `major`.
Please always include the `firebase` package with the same version bump type as
your package. This is to ensure that the version of the `firebase` package will
be bumped correctly. For example,

```
---
"@firebase/storage": minor
"firebase": minor
---

This is a test.
```

#### Multiple changeset files

If your PR touches multiple SDKs or addresses multiple issues that require
different version bump or different description, you can create multiple
changeset files in the PR.

## <a name="docs"></a> Updating Documentation

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/).
Expand Down