From 04bc9cc2528c9216bf07baa0171acd1b7d26b352 Mon Sep 17 00:00:00 2001 From: katowulf Date: Tue, 27 Sep 2016 10:19:04 -0700 Subject: [PATCH 1/3] Update GitHub templates. --- CONTRIBUTING.md | 134 +++++++++++++++++++++++++++++++++++++++ CONTRIBUTOR.md | 41 ------------ ISSUE_TEMPLATE.md | 77 ++++++++++++++++++++++ PULL_REQUEST_TEMPLATE.md | 39 ++++++++++++ 4 files changed, 250 insertions(+), 41 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 CONTRIBUTOR.md create mode 100644 ISSUE_TEMPLATE.md create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..6b164c946 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,134 @@ +# Contributing to AngularFire2 + +We would love for you to contribute to AngularFire2 and help make it even better than it is +today! As a contributor, here are the guidelines we would like you to follow: + + - [Code of Conduct](#coc) + - [Question or Problem?](#question) + - [Issues and Bugs](#issue) + - [Feature Requests](#feature) + - [Submission Guidelines](#submit) + - [Coding Rules][rules] + - [Commit Message Guidelines][commit] + - [Signing the CLA](#cla) + +## Code of Conduct +Help us keep the Angular and Firebase communities open and inclusive. Please read and follow the Angular [Code of Conduct][coc]. + +## Got a Question or Problem? + +If you have questions about how to *use* AngularFire, please direct them to the [Angular Google Group][angular-group] +discussion list or [StackOverflow][stackoverflow] (include the firebase and angular tags in your posts!). +Please note that the Angular team's capacity to answer usage questions is limited. +Members of the Firebase team can be reached on [Slack][slack] and via the [Firebase Google Group][firebase-group]. + +## Found an Issue? +If you find a bug in the source code, you can help us by +[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can +[submit a Pull Request](#submit-pr) with a fix. + +## Want a Feature? +You can *request* a new feature by [submitting an issue](#submit-issue) to our [GitHub +Repository][github]. If you would like to *implement* a new feature, please submit an issue with +a proposal for your work first, to be sure that we can use it. +Please consider what kind of change it is: + +* For a **Major Feature**, first open an issue and outline your proposal so that it can be +discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, +and help you to craft the change so that it is successfully accepted into the project. +* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). + +## Submission Guidelines + +### Submitting an Issue +Help us to maximize the effort we can spend improving the product by not reporting duplicate issues. +Search the archives before you submit. + +Providing the following information will increase the chances of your issue being dealt with quickly: + +* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps +* **Angular Version** - what version of Angular, Firebase, and AngularFire are you using? +* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you +* **Browsers and Operating System** - is this a problem with all browsers? +* **Reproduce the Error** - provide a live example (using [Plunker][plunker], + [JSFiddle][jsfiddle] or [Runnable][runnable]) or a unambiguous set of steps +* **Related Issues** - has a similar issue been reported before? +* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be + causing the problem (line of code or commit) + +You can file new issues by providing the above information [here](https://github.com/angular/angularfire2/issues/new). + +### Submitting a Pull Request (PR) + +Before you submit your Pull Request (PR) consider the following guidelines: + +* Ensure proposed changes or problem have already been clearly defined and + discussed in the issue tracker. We don't want you to burn time on code + that isn't a good fit for the project. +* Search [GitHub](https://github.com/angular/angularfire2/pulls) for an open or closed PR + that relates to your submission. You don't want to duplicate effort. +* Please sign our [Contributor License Agreement (CLA)](#cla) before sending PRs. + We cannot accept code without this. +* Make your changes in a new git branch: + + ```shell + git checkout -b my-fix-branch master + ``` + +* Create your patch, **including appropriate test cases**. +* Follow the [Angular Coding Rules](rules). +* Run the full test suite, as described in the [developer documentation][dev-doc], + and ensure that all tests pass. +* Commit your changes using a descriptive commit message that follows the + [Angular commit message conventions](commit). Adherence to these conventions + is necessary because release notes are automatically generated from these messages. + + ```shell + git commit -a + ``` + Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. + +* Push your branch to GitHub: + + ```shell + git push origin my-fix-branch + ``` + +* In GitHub, send a pull request to `angular:master`. +* If we suggest changes then: + * Make the required updates. + * Re-run the test suites to ensure tests are still passing. + * Rebase your branch and force push to your GitHub repository (this will update your Pull Request): + + ```shell + git rebase master -i + git push -f + ``` + +That's it! Thank you for your contribution! + +## Signing the CLA + +Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code +changes to be accepted, the CLA must be signed. It's a quick process, we promise! + +* For individuals we have a [simple click-through form][individual-cla]. +* For corporations we'll need you to + [print, sign and one of scan+email, fax or mail the form][corporate-cla]. + + +[slack]: https://firebase-community.appspot.com/ +[coc]: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md +[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit# +[corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html +[individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html +[js-style-guide]: https://google.github.io/styleguide/javascriptguide.xml +[jsfiddle]: http://jsfiddle.net +[plunker]: http://plnkr.co/edit +[runnable]: http://runnable.com +[github]: https://github.com/angular/angularfire2 +[stackoverflow]: http://stackoverflow.com/questions/tagged/angularfire +[rules]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#rules +[commit]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines +[angular-group]: https://groups.google.com/forum/#!forum/angular +[firebase-group]: https://groups.google.com/forum/#!forum/firebase-talk \ No newline at end of file diff --git a/CONTRIBUTOR.md b/CONTRIBUTOR.md deleted file mode 100644 index e68f7710b..000000000 --- a/CONTRIBUTOR.md +++ /dev/null @@ -1,41 +0,0 @@ -## Contributing Process -1. Create an issue to open the line of communication. **Please create an issue before sending a PR :)** -2. Discussion on the issue. -3. PR sent based on discussion. - -## Initial Setup - -``` -$ npm install -$ npm run build -$ npm test -``` - -## Build CJS/ES5 Output - -`$ npm run build` - -## Run Karma Against CJS/ES5 Output - -`$ npm test` - -## Build Docs - -`$ npm run docs` - -## Build and Deploy Docs to Firebase Hosting - -(Ask @jeffbcross to add you as a collaborator) - -``` -$ npm install -g firebase-tools -$ firebase login -$ npm run docs -$ cd docs -$ firebase deploy -``` - -## Error TS6053: File '...index.d.ts' not found. - -You may need to run `typings install` - diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..351723dd5 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,77 @@ + + + +### Version info + + + +**Angular:** + +**Firebase:** + +**AngularFire:** + +**Other (e.g. Node, browser, operating system) (if applicable):** + +### Test case + + + +### Debug output + +** Errors in the JavaScript console ** + +** Output from `firebase.database().enableLogging(true);` ** + +** Screenshots ** + +### Steps to reproduce + + + + +### Expected behavior + + + + +### Actual behavior + + \ No newline at end of file diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..7b4504cec --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,39 @@ + + +### Checklist + + - Issue number for this PR: #nnn (required) + - Docs included?: (yes/no; required for all API/functional changes) + - Test units included?: (yes/no; required) + - e2e tests included?: (yes/no; required for multi-function/multi-class changes) + - In a clean directory, `npm install`, `npm run build`, and `npm test` run successfully? (yes/no; required) + +### Description + + + +### Code sample + + + From ba179f3a7abe430a58088e4560b7dd7ddf384d6f Mon Sep 17 00:00:00 2001 From: katowulf Date: Tue, 27 Sep 2016 10:32:40 -0700 Subject: [PATCH 2/3] Restore installation section to contributing doc. --- CONTRIBUTING.md | 51 +++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 45 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b164c946..6b7e65ce5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,12 +7,14 @@ today! As a contributor, here are the guidelines we would like you to follow: - [Question or Problem?](#question) - [Issues and Bugs](#issue) - [Feature Requests](#feature) + - [Initial Setup](#setup) - [Submission Guidelines](#submit) - [Coding Rules][rules] - [Commit Message Guidelines][commit] - [Signing the CLA](#cla) ## Code of Conduct + Help us keep the Angular and Firebase communities open and inclusive. Please read and follow the Angular [Code of Conduct][coc]. ## Got a Question or Problem? @@ -23,11 +25,13 @@ Please note that the Angular team's capacity to answer usage questions is limite Members of the Firebase team can be reached on [Slack][slack] and via the [Firebase Google Group][firebase-group]. ## Found an Issue? + If you find a bug in the source code, you can help us by [submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can [submit a Pull Request](#submit-pr) with a fix. ## Want a Feature? + You can *request* a new feature by [submitting an issue](#submit-issue) to our [GitHub Repository][github]. If you would like to *implement* a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. @@ -38,6 +42,25 @@ discussed. This will also allow us to better coordinate our efforts, prevent dup and help you to craft the change so that it is successfully accepted into the project. * **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). +## Initial Setup + +1. Create a fork of AngularFire2 (See [Forking a Project][github-fork]) + +2. CD into your clone and install dependencies + +```shell +$ git clone +$ npm install +$ npm run build +$ npm test +``` + +3. Make your changes in a new git branch: + +```shell +git checkout -b my-fix-branch master +``` + ## Submission Guidelines ### Submitting an Issue @@ -60,7 +83,7 @@ You can file new issues by providing the above information [here](https://github ### Submitting a Pull Request (PR) -Before you submit your Pull Request (PR) consider the following guidelines: +#### Before you submit: * Ensure proposed changes or problem have already been clearly defined and discussed in the issue tracker. We don't want you to burn time on code @@ -69,11 +92,8 @@ Before you submit your Pull Request (PR) consider the following guidelines: that relates to your submission. You don't want to duplicate effort. * Please sign our [Contributor License Agreement (CLA)](#cla) before sending PRs. We cannot accept code without this. -* Make your changes in a new git branch: - ```shell - git checkout -b my-fix-branch master - ``` +#### How to submit: * Create your patch, **including appropriate test cases**. * Follow the [Angular Coding Rules](rules). @@ -107,6 +127,24 @@ Before you submit your Pull Request (PR) consider the following guidelines: That's it! Thank you for your contribution! +#### Deploying Docs + +1. Build the docs + +`$ npm run docs` + +2. Deploy Docs to Firebase Hosting + +(Ask @jeffbcross to add you as a collaborator or deploy on your behalf) + +``` +$ npm install -g firebase-tools +$ firebase login +$ npm run docs +$ cd docs +$ firebase deploy +``` + ## Signing the CLA Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code @@ -131,4 +169,5 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise [rules]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#rules [commit]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines [angular-group]: https://groups.google.com/forum/#!forum/angular -[firebase-group]: https://groups.google.com/forum/#!forum/firebase-talk \ No newline at end of file +[firebase-group]: https://groups.google.com/forum/#!forum/firebase-talk +[github-fork]: https://help.github.com/articles/fork-a-repo/ \ No newline at end of file From 03deb77ef55991a60f854305edcd594ffa93b27a Mon Sep 17 00:00:00 2001 From: katowulf Date: Tue, 27 Sep 2016 10:40:07 -0700 Subject: [PATCH 3/3] Fix formatting and link syntax. --- CONTRIBUTING.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b7e65ce5..0381972ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,8 +9,8 @@ today! As a contributor, here are the guidelines we would like you to follow: - [Feature Requests](#feature) - [Initial Setup](#setup) - [Submission Guidelines](#submit) - - [Coding Rules][rules] - - [Commit Message Guidelines][commit] + - [Coding Rules][rules] (external link) + - [Commit Message Guidelines][commit] (external link) - [Signing the CLA](#cla) ## Code of Conduct @@ -20,7 +20,7 @@ Help us keep the Angular and Firebase communities open and inclusive. Please rea ## Got a Question or Problem? If you have questions about how to *use* AngularFire, please direct them to the [Angular Google Group][angular-group] -discussion list or [StackOverflow][stackoverflow] (include the firebase and angular tags in your posts!). +discussion list or [StackOverflow][stackoverflow] (include the `firebase` and `angular` tags!). Please note that the Angular team's capacity to answer usage questions is limited. Members of the Firebase team can be reached on [Slack][slack] and via the [Firebase Google Group][firebase-group]. @@ -44,9 +44,9 @@ and help you to craft the change so that it is successfully accepted into the pr ## Initial Setup -1. Create a fork of AngularFire2 (See [Forking a Project][github-fork]) +1) Create a fork of AngularFire2 (See [Forking a Project][github-fork]) -2. CD into your clone and install dependencies +2) CD into your clone and install dependencies ```shell $ git clone @@ -55,7 +55,7 @@ $ npm run build $ npm test ``` -3. Make your changes in a new git branch: +3) Make your changes in a new git branch: ```shell git checkout -b my-fix-branch master @@ -96,11 +96,11 @@ You can file new issues by providing the above information [here](https://github #### How to submit: * Create your patch, **including appropriate test cases**. -* Follow the [Angular Coding Rules](rules). +* Follow the [Angular Coding Rules][rules]. * Run the full test suite, as described in the [developer documentation][dev-doc], and ensure that all tests pass. * Commit your changes using a descriptive commit message that follows the - [Angular commit message conventions](commit). Adherence to these conventions + [Angular commit message conventions][commit]. Adherence to these conventions is necessary because release notes are automatically generated from these messages. ```shell @@ -129,11 +129,11 @@ That's it! Thank you for your contribution! #### Deploying Docs -1. Build the docs +1) Build the docs `$ npm run docs` -2. Deploy Docs to Firebase Hosting +2) Deploy Docs to Firebase Hosting (Ask @jeffbcross to add you as a collaborator or deploy on your behalf)