Skip to content

Commit 788fac1

Browse files
committed
update COLLABORATOR_GUIDE and CONTRIBUTING
1 parent 7f67e87 commit 788fac1

File tree

2 files changed

+21
-14
lines changed

2 files changed

+21
-14
lines changed

COLLABORATOR_GUIDE.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,29 +65,33 @@ test should *fail* before the change, and *pass* after the change.
6565

6666
### Building documentation
6767

68-
Create a file with the name ```.release.json``` and put your GitHub token
69-
into it so that it be read with JSON.parse:
68+
For local builds run ```node docs/server.js```.
69+
70+
To update the live page, create a file with the name ```.release.json```,
71+
[generate a GitHub token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/)
72+
and put it into the file so that it be read with JSON.parse:
7073

7174
```
7275
"abc123..."
7376
```
7477

75-
Run ```node release.js``` which will build it from the "docs" directory and then commit it to gh-pages automatically.
78+
Then run ```node release.js``` which will build it from the "docs" directory
79+
and commit it to gh-pages automatically.
7680

7781
### Releasing
7882

7983
Open an issue with a proposed changelog and semver-compatible version number.
8084

8185
Once this has been approved by the Collaborators, run ```npm prepublish```,
82-
update ```History.md``` with the new changelog and bump the version number in
83-
```package.json``` and ```component.json```.
86+
update ```History.md``` with the new changelog, bump the version number in
87+
```package.json``` as well as ```component.json``` and tag the new release.
8488

8589
Commit these changes and run ```npm publish```.
8690

8791
### I just made a mistake
8892

8993
With git, there's a way to override remote trees by force pushing
90-
(`git push -f`). This should generally be seen as forbidden (since
94+
(`git push -f`). On master, this should be seen as forbidden (since
9195
you're rewriting history on a repository other people are working
9296
against) but is allowed for simpler slip-ups such as typos in commit
9397
messages. However, you are only allowed to force push to any jade

CONTRIBUTING.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Contributing to jade
22

3+
Please feel free to open an issue with jade for *any* communication, such as
4+
questions or bugs.
5+
6+
For bugs, please search the docs first. If the bug persists, please create an
7+
issue and post the entire error message, log and source code, so that it can
8+
be reproduced as accurately as possible.
9+
310
### Step 1: Fork
411

512
Fork the project [on GitHub](https://github.com/jadejs/jade) and check out your
@@ -52,9 +59,6 @@ structured (license boilerplate, common includes, etc.).
5259
$ npm test
5360
```
5461

55-
Make sure that all tests pass. Please, do not submit patches that fail.
56-
57-
5862
### Step 6: Push
5963

6064
```text
@@ -113,11 +117,10 @@ CoC](http://www.rust-lang.org/conduct.html).
113117
excludes people in socially marginalized groups.
114118
* Private harassment is also unacceptable. No matter who you are, if
115119
you feel you have been or are being harassed or made uncomfortable
116-
by a community member, please contact one of the channel ops or any
117-
of the TC members immediately with a capture (log, photo, email) of
118-
the harassment if possible. Whether you're a regular contributor or
119-
a newcomer, we care about making this community a safe place for you
120-
and we've got your back.
120+
by a community member, please open an issue immediately with a capture
121+
(log, photo, email) of the harassment if possible. Whether you're a
122+
regular contributor or a newcomer, we care about making this community
123+
a safe place for you and we've got your back.
121124
* Likewise any spamming, trolling, flaming, baiting or other
122125
attention-stealing behaviour is not welcome.
123126
* Avoid the use of personal pronouns in code comments or

0 commit comments

Comments
 (0)