From da65500545fb4581e0398aa4c792c0c3418680e9 Mon Sep 17 00:00:00 2001 From: Chris Wheatley Date: Wed, 14 Jan 2015 22:11:46 +0000 Subject: [PATCH 1/2] expand upon the contributing guidelines --- CONTRIBUTING.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad8ff721f5..3a6648b98c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,18 @@ # Contributing -Before contributing, please read the [code of conduct](https://github.com/6to5/6to5/blob/master/CODE_OF_CONDUCT.md). +Contributions are always welcome, no matter how large or small. Before contributing, please read the [code of conduct](https://github.com/6to5/6to5/blob/master/CODE_OF_CONDUCT.md). + +## Developing + +#### Workflow + +* Fork the repository +* Clone your fork and change directory to it (`git clone git@github.com:yourUserName/6to5.git && cd 6to5`) +* Link your forked clone (`npm link`) +* Develop your changes ensuring you're fetching changes from upstream often +* Create new pull request explaining your proposed change or reference an issue in your commit message + +#### Code Standards * **General** * No ES6 syntax features or methods, exclusively ES5. From a14f971b8a7c4d4fce3d5a83f9afe93309db5095 Mon Sep 17 00:00:00 2001 From: Chris Wheatley Date: Wed, 14 Jan 2015 22:25:20 +0000 Subject: [PATCH 2/2] add further commands required for workflow --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3a6648b98c..c87a5112a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,8 +8,10 @@ Contributions are always welcome, no matter how large or small. Before contribut * Fork the repository * Clone your fork and change directory to it (`git clone git@github.com:yourUserName/6to5.git && cd 6to5`) +* Install the project dependencies (`npm install`) * Link your forked clone (`npm link`) -* Develop your changes ensuring you're fetching changes from upstream often +* Develop your changes ensuring you're fetching updates from upstream often +* Ensure the test are passing (`make test`) * Create new pull request explaining your proposed change or reference an issue in your commit message #### Code Standards