Skip to content

Commit 346f407

Browse files
committed
WIP: updates from review
1 parent 6cd2e77 commit 346f407

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

CONTRIBUTING.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,11 @@ We promise to extend courtesy and respect to everyone involved in this project r
2020

2121
If any member of the community violates this code of conduct, the maintainers of the Firebase JS SDK project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate.
2222

23-
If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at [email protected].
24-
23+
If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at [email protected].
2524

2625
## <a name="question"></a> Got a Question?
2726

28-
If you have questions about how to use the Firebase JS SDK, please direct these to [StackOverflow][stackoverflow] and use the `firebase` tag. You can also use the [Firebase Google Group][firebase-google-group] or [Slack][slack] to contact members of the Firebase team for help.
27+
If you have questions about how to use the Firebase JS SDK, please direct these to [StackOverflow][stackoverflow] and use the `firebase` and `javascript` tags. You can also use the [Firebase Google Group][firebase-google-group] or [Slack][slack] to contact members of the Firebase team for help.
2928

3029
## <a name="issue"></a> Found an Issue?
3130

@@ -41,9 +40,9 @@ If you have a production issue, please [contact Firebase support][support] who w
4140

4241
### Submitting an Issue
4342

44-
Before you submit your issue search [past issues][archive], [StackOverflow][stackoverflow], and the [Firebase Google Group][firebase-google-group] maybe your question was already answered.
43+
Before you submit your issue, search [past issues][archive], [StackOverflow][stackoverflow], and the [Firebase Google Group][firebase-google-group] maybe your question was already answered. You can help us to maximize the effort we spend fixing issues, and adding new features, by not reporting duplicate issues.
4544

46-
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:
45+
If your issue appears to be a bug, and hasn't been reported, open a new issue. Providing the following information will increase the chances of your issue being dealt with quickly:
4746

4847
* **Description of the Issue** - if an error is being thrown a non-minified stack trace helps
4948
* **Motivation for or Use Case** - explain why this is a bug for you
@@ -62,20 +61,23 @@ Also as a great rule of thumb:
6261

6362
### Before you contribute
6463

65-
Before we can use your code, you must sign the [Google Individual Contributor License Agreement][google-cla] (CLA), which you can do online. The CLA is necessary mainly because you own the copyright to your changes, even after your contribution becomes part of our codebase, so we need your permission to use and distribute your code. We also need to be sure of various other things—for instance that you'll tell us if you know that your code infringes on other people's patents. You don't have to sign the CLA until after you've submitted your code for review and a member has approved it, but you must do it before we can put your code into our codebase. Before you start working on a larger contribution, you should get in touch with us first through the issue tracker with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on.
64+
Before we can use your code, you must sign the [Google Individual Contributor License Agreement][google-cla] (CLA), which you can do online. The CLA is necessary mainly because you own the copyright to your changes, even after your contribution becomes part of our codebase, so we need your permission to use and distribute your code. We also need to be sure of various other things, for instance, that you'll tell us if you know that your code infringes on other people's patents. You don't have to sign the CLA until after you've submitted your code for review and a member has approved it, but you must do it before we can put your code into our codebase.
65+
66+
Before you start working on a larger contribution, you should get in touch with us first through the issue tracker with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on.
6667

6768
### Pull Request Guidelines
6869

6970
* Search [GitHub](https://github.com/firebase/firebase-js-sdk/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
7071
* Create an issue to discuss a change before submitting a PR. We'd hate to have to turn down your contributions because of something that could have been communicated early on.
72+
* [Create a fork of the GitHub repo][fork-repo] to ensure that you can push your changes for us to review.
7173
* Make your changes in a new git branch:
7274

7375
```shell
7476
git checkout -b my-fix-branch master
7577
```
7678

7779
* Create your patch, **including appropriate test cases**. Patches with tests are more likely to be merged.
78-
* Avoid checking in files that shouldn't be tracked (e.g `node_modules`, `gulp-cache`, `.tmp`, `.idea`). We recommend using a [global](#global-gitignore) gitignore for this.
80+
* Avoid checking in files that shouldn't be tracked (e.g `node_modules`, `gulp-cache`, `.tmp`, `.idea`). If your development setup automatically creates some of these files, please add them to the `.gitignore` at the root of the package (click [here][gitignore] to read more on how to add entries to the `.gitignore`).
7981
* Commit your changes using a commit message that follows our [commit message guidelines](#commit-message-guidelines).
8082

8183
```shell
@@ -89,14 +91,14 @@ Before we can use your code, you must sign the [Google Individual Contributor Li
8991
npm test
9092
```
9193

92-
* Push your branch to GitHub:
94+
* Push your branch to your fork on GitHub:
9395

9496
```shell
9597
git push origin my-fix-branch
9698
```
9799

98100
* In GitHub, send a pull request to `firebase-js-sdk:master`.
99-
* 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.
101+
* 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.
100102

101103
That's it! Thank you for your contribution!
102104
@@ -113,8 +115,9 @@ you can simply use `git cz` to create properly formatted commit messages.
113115
[archive]: https://github.com/firebase/firebase-js-sdk/issues?utf8=%E2%9C%93&q=is%3Aissue
114116
[file-an-issue]: https://github.com/firebase/firebase-js-sdk/issues/new
115117
[firebase-google-group]: https://groups.google.com/forum/#!forum/firebase-talk
118+
[fork-repo]: https://github.com/firebase/firebase-js-sdk/fork
116119
[github]: https://github.com/firebase/firebase-js-sdk
117-
[global-gitignore]: https://help.github.com/articles/ignoring-files/#create-a-global-gitignore
120+
[gitignore]: https://git-scm.com/docs/gitignore
118121
[google-cla]: https://cla.developers.google.com/about/google-individual
119122
[js-style-guide]: http://google.github.io/styleguide/javascriptguide.xml
120123
[jsbin]: http://jsbin.com/rinilu/edit?js,console

0 commit comments

Comments
 (0)