Contributing updates [triage-skip] #113

jshcrowthe · 2017-07-26T23:24:56Z

Update the CONTRIBUTING.md to better communicate community expectations.

paulb777

Looks great! Thanks Josh!

paulb777 · 2017-07-26T23:37:03Z

CONTRIBUTING.md

+
+We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the project to do the same.
+
+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.


See https://groups.google.com/a/google.com/forum/#!msg/opensource-discuss/aBFlzXw_kBw/KrZuKGh0AwAJ

This is an adaptation of the functions-samples CoC. If we later want to update this that shouldn't be too bad.

paulb777 · 2017-07-26T23:38:47Z

CONTRIBUTING.md

+
+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.
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at samstern@google.com. 


An alias to a group might be better - firebase-code-of-conduct@google.com

Great idea! I'll route this there instead.

paulb777 · 2017-07-26T23:40:04Z

CONTRIBUTING.md

+
+## <a name="question"></a> Got a Question?
+
+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.


and javascript tag

paulb777 · 2017-07-26T23:40:18Z

CONTRIBUTING.md

+
+### Submitting an Issue
+
+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.


Comma after issue

paulb777 · 2017-07-26T23:41:35Z

CONTRIBUTING.md

+
+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.
+
+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:


Delete "Help ..." sentence. It was just pointed out in the previous sentence - "Before ...

Moved the sentence up as explaining the rationale seems like a good idea to me.

paulb777 · 2017-07-26T23:44:02Z

CONTRIBUTING.md

-one above, the [Software Grant and Corporate Contributor License
-Agreement](https://cla.developers.google.com/about/google-corporate).
+* Create your patch, **including appropriate test cases**. Patches with tests are more likely to be merged.
+* 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.


Don't we have a .gitignore in the project already? The #global-gitignore link goes nowhere.

Yup, I rehashed this sentence.

paulb777 · 2017-07-26T23:45:47Z

CONTRIBUTING.md

+
+That's it! Thank you for your contribution!
+
+## <a name="commit-message-guidelines"></a> Commit Message Guidelines

 This repository follows the commit message format defined by the 
 [validate-commit-msg](https://npm.im/validate-commit-msg) package on NPM. This is
 to make the git history easy to follow, and make it easier to identify which
 commits are associated with features, bugfixes, etc.

 We are also Commitizen friendly! If you have the [Commitizen CLI](https://npm.im/commitizen) installed


Comma after CLI

Can't see exactly what you're referring to, the phrase "CLI" only occurs once in the whole doc.

oops, after installed - If you have the Commitizen CLI installed,

samtstern · 2017-07-27T14:49:39Z

CONTRIBUTING.md

-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.
+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.


nit: 'things—for' is strange punctuation.

Also I'd split this paragraph into two. One about the CLA, one about large PRs.

samtstern · 2017-07-27T14:52:05Z

CONTRIBUTING.md

+* Push your branch to GitHub:
+
+    ```shell
+    git push origin my-fix-branch


If they're following along they have not forked yet, so at this point origin is our repo and this command will fail.

Great point. I'll put in a link to fork the repo first.

hiranya911 · 2017-07-27T17:32:49Z

CONTRIBUTING.md

+
+### Submitting an Issue
+
+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. 


Revise wording in this sentence.

hiranya911 · 2017-07-27T17:34:50Z

CONTRIBUTING.md

-possibly guide you. Coordinating up front makes it much easier to avoid
-frustration later on.
+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. 
+


Mention that a bot will guide them through this process, when they submit a PR.

hiranya911 · 2017-07-27T17:36:04Z

CONTRIBUTING.md

-frustration later on.
+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.


Perhaps mention that big changes may also require other internal review and approvals (launchcals, API reviews etc), which may take additional time.

paulb777 · 2017-07-27T19:36:32Z

Should the Code of Conduct be a separate document? From https://github.com/firebase/firebase-ios-sdk/community, it's what's missing to get to 100% on recommended community standards.

jshcrowthe · 2017-07-27T20:55:49Z

I think we could cross post it there sure! It's a good thing for people to read and be aware of.

EDIT: There are some provided templates there that are far more detailed than what we have. Does it make sense to have a CODE_OF_CONDUCT.md developed in a little bit more official capacity?

rsattar

LGTM! 👍

hiranya911 · 2017-07-28T17:48:24Z

LGTM

)

jshcrowthe added 2 commits July 26, 2017 15:59

WIP: update CONTRIBUTING.md

ce7b0be

WIP: 1st draft contributing guidelines

c9a7af3

jshcrowthe requested review from paulb777, katowulf, depoll, hiranya911 and samtstern July 26, 2017 23:24

WIP: slight updates

6cd2e77

jshcrowthe force-pushed the contributing-updates branch from 9c05510 to 6cd2e77 Compare July 26, 2017 23:29

paulb777 reviewed Jul 26, 2017

View reviewed changes

samtstern previously approved these changes Jul 27, 2017

View reviewed changes

WIP: updates from review

346f407

jshcrowthe dismissed samtstern’s stale review via 346f407 July 27, 2017 17:28

hiranya911 reviewed Jul 27, 2017

View reviewed changes

WIP: changes from @hiranya911

0535569

Merge branch 'master' into contributing-updates

e4e3f08

rsattar reviewed Jul 28, 2017

View reviewed changes

paulb777 approved these changes Jul 28, 2017

View reviewed changes

jshcrowthe merged commit 7ccc77c into master Jul 28, 2017

jshcrowthe deleted the contributing-updates branch July 28, 2017 19:00

Feiyang1 pushed a commit that referenced this pull request Apr 30, 2019

Prepend "w:" to the package version that is reported to the server (#113

c48dba0

)

firebase locked and limited conversation to collaborators Oct 26, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contributing updates [triage-skip] #113

Contributing updates [triage-skip] #113

jshcrowthe commented Jul 26, 2017

paulb777 left a comment

paulb777 Jul 26, 2017

jshcrowthe Jul 27, 2017

paulb777 Jul 26, 2017

jshcrowthe Jul 27, 2017

paulb777 Jul 26, 2017

jshcrowthe Jul 27, 2017

paulb777 Jul 26, 2017

jshcrowthe Jul 27, 2017

paulb777 Jul 26, 2017

jshcrowthe Jul 27, 2017

paulb777 Jul 26, 2017

jshcrowthe Jul 27, 2017

paulb777 Jul 26, 2017

jshcrowthe Jul 27, 2017

paulb777 Jul 27, 2017

samtstern Jul 27, 2017

samtstern Jul 27, 2017

jshcrowthe Jul 27, 2017

samtstern Jul 27, 2017

jshcrowthe Jul 27, 2017

hiranya911 Jul 27, 2017

jshcrowthe Jul 27, 2017

hiranya911 Jul 27, 2017

jshcrowthe Jul 27, 2017

hiranya911 Jul 27, 2017

jshcrowthe Jul 27, 2017

paulb777 commented Jul 27, 2017

jshcrowthe commented Jul 27, 2017 •

edited

Loading

rsattar left a comment

hiranya911 commented Jul 28, 2017


		We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the project to do the same.

		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.


		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.

		If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at samstern@google.com.


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

		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.


		### Submitting an Issue

		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.


		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.

		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:


		### Submitting an Issue

		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.

Contributing updates [triage-skip] #113

Contributing updates [triage-skip] #113

Conversation

jshcrowthe commented Jul 26, 2017

paulb777 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulb777 commented Jul 27, 2017

jshcrowthe commented Jul 27, 2017 • edited Loading

rsattar left a comment

Choose a reason for hiding this comment

hiranya911 commented Jul 28, 2017

jshcrowthe commented Jul 27, 2017 •

edited

Loading