Skip to content

docs(contributing): update for yarn #2084

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 1 commit into from
May 24, 2019
Merged

docs(contributing): update for yarn #2084

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 5 additions & 25 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,12 @@ and help you to craft the change so that it is successfully accepted into the pr

1) Create a fork of AngularFire (See [Forking a Project][github-fork])

2) CD into your clone and install dependencies
2) Clone your fork, CD into the directory, and install dependencies

```shell
$ git clone
$ npm install
$ npm run build
$ npm test
$ git clone <your fork SSH/HTTPS from GitHub>
$ yarn install
$ yarn test
```

3) Make your changes in a new git branch:
Expand Down Expand Up @@ -105,8 +104,7 @@ You can file new issues by providing the above information [here](https://github

* 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.
* Run the full test suite (`yarn test`) 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.
Expand Down Expand Up @@ -135,24 +133,6 @@ You can file new issues by providing the above information [here](https://github

That's it! Thank you for your contribution!

#### <a name="submit-docs"></a> 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
```

## <a name="cla"></a> Signing the CLA

Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code
Expand Down