From 3ebf1ed9bf8ffa05d9385b3394dd1d4fb2f89a96 Mon Sep 17 00:00:00 2001 From: Andreas Lubbe Date: Thu, 18 Jun 2015 12:10:40 +0200 Subject: [PATCH] update COLLABORATOR_GUIDE and CONTRIBUTING --- COLLABORATOR_GUIDE.md | 16 ++++++++++------ CONTRIBUTING.md | 19 +++++++++++-------- 2 files changed, 21 insertions(+), 14 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index c0b987ed8..176bd9a28 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a2e0b564..846a5720b 100644 --- a/CONTRIBUTING.md +++ b/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 @@ -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 @@ -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