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
+13-10
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,11 @@ We promise to extend courtesy and respect to everyone involved in this project r
20
20
21
21
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.
22
22
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].
25
24
26
25
## <aname="question"></a> Got a Question?
27
26
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.
29
28
30
29
## <aname="issue"></a> Found an Issue?
31
30
@@ -41,9 +40,9 @@ If you have a production issue, please [contact Firebase support][support] who w
41
40
42
41
### Submitting an Issue
43
42
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.
45
44
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:
47
46
48
47
***Description of the Issue** - if an error is being thrown a non-minified stack trace helps
49
48
***Motivation for or Use Case** - explain why this is a bug for you
@@ -62,20 +61,23 @@ Also as a great rule of thumb:
62
61
63
62
### Before you contribute
64
63
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.
66
67
67
68
### Pull Request Guidelines
68
69
69
70
* 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.
70
71
* 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.
71
73
* Make your changes in a new git branch:
72
74
73
75
```shell
74
76
git checkout -b my-fix-branch master
75
77
```
76
78
77
79
* 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`).
79
81
* Commit your changes using a commit message that follows our [commit message guidelines](#commit-message-guidelines).
80
82
81
83
```shell
@@ -89,14 +91,14 @@ Before we can use your code, you must sign the [Google Individual Contributor Li
89
91
npm test
90
92
```
91
93
92
-
* Push your branch to GitHub:
94
+
* Push your branch to your fork on GitHub:
93
95
94
96
```shell
95
97
git push origin my-fix-branch
96
98
```
97
99
98
100
* 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.
100
102
101
103
That's it! Thank you for your contribution!
102
104
@@ -113,8 +115,9 @@ you can simply use `git cz` to create properly formatted commit messages.
0 commit comments