Skip to content

Commit 8e499e9

Browse files
Splaktarjamesdaniels
authored andcommitted
docs(contributing): update for yarn (#2084)
remove out of date docs deployment instructions
1 parent 2469e77 commit 8e499e9

File tree

1 file changed

+5
-25
lines changed

1 file changed

+5
-25
lines changed

CONTRIBUTING.md

+5-25
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,12 @@ and help you to craft the change so that it is successfully accepted into the pr
5252

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

55-
2) CD into your clone and install dependencies
55+
2) Clone your fork, CD into the directory, and install dependencies
5656

5757
```shell
58-
$ git clone
59-
$ npm install
60-
$ npm run build
61-
$ npm test
58+
$ git clone <your fork SSH/HTTPS from GitHub>
59+
$ yarn install
60+
$ yarn test
6261
```
6362

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

106105
* Create your patch, **including appropriate test cases**.
107106
* Follow the [Angular Coding Rules][rules].
108-
* Run the full test suite, as described in the [developer documentation][dev-doc],
109-
and ensure that all tests pass.
107+
* Run the full test suite (`yarn test`) and ensure that all tests pass.
110108
* Commit your changes using a descriptive commit message that follows the
111109
[Angular commit message conventions][commit]. Adherence to these conventions
112110
is necessary because release notes are automatically generated from these messages.
@@ -135,24 +133,6 @@ You can file new issues by providing the above information [here](https://github
135133

136134
That's it! Thank you for your contribution!
137135
138-
#### <a name="submit-docs"></a> Deploying Docs
139-
140-
1) Build the docs
141-
142-
`$ npm run docs`
143-
144-
2) Deploy Docs to Firebase Hosting
145-
146-
(Ask @jeffbcross to add you as a collaborator or deploy on your behalf)
147-
148-
```
149-
$ npm install -g firebase-tools
150-
$ firebase login
151-
$ npm run docs
152-
$ cd docs
153-
$ firebase deploy
154-
```
155-
156136
## <a name="cla"></a> Signing the CLA
157137
158138
Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code

0 commit comments

Comments
 (0)