Skip to content

Commit

Permalink
update COLLABORATOR_GUIDE and CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
alubbe committed Jun 18, 2015
1 parent f1d7720 commit 3ebf1ed
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 14 deletions.
16 changes: 10 additions & 6 deletions COLLABORATOR_GUIDE.md
Expand Up @@ -65,29 +65,33 @@ test should *fail* before the change, and *pass* after the change.

### Building documentation

Create a file with the name ```.release.json``` and put your GitHub token
into it so that it be read with JSON.parse:
For local builds run ```node docs/server.js```.

To update the live page, create a file with the name ```.release.json```,
[generate a GitHub token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/)
and put it into the file so that it be read with JSON.parse:

```
"abc123..."
```

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

### Releasing

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

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

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

### I just made a mistake

With git, there's a way to override remote trees by force pushing
(`git push -f`). This should generally be seen as forbidden (since
(`git push -f`). On master, this should be seen as forbidden (since
you're rewriting history on a repository other people are working
against) but is allowed for simpler slip-ups such as typos in commit
messages. However, you are only allowed to force push to any jade
Expand Down
19 changes: 11 additions & 8 deletions CONTRIBUTING.md
@@ -1,5 +1,12 @@
# Contributing to jade

Please feel free to open an issue with jade for *any* communication, such as
questions or bugs.

For bugs, please search the docs first. If the bug persists, please create an
issue and post the entire error message, log and source code, so that it can
be reproduced as accurately as possible.

### Step 1: Fork

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

Make sure that all tests pass. Please, do not submit patches that fail.


### Step 6: Push

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

0 comments on commit 3ebf1ed

Please sign in to comment.