Adds step-by-step instructions for contribution to README.md:
Getting Started
- Clone this repo:
git clone https://github.com/CrisisTextLine/CrisisTrends
- Install Gulp and other depends:
npm install -g gulp
npm install
- Start gulp server:
gulp serve
Start Coding
- Fork this repository.
- Clone the new fork:
git clone https://github.com/$YOUR-GITHUB-USER-NAME/CrisisTrends
- Set up depends:
npm install -g gulp
npm install
- Create a branch for your bugfix/feature/etc
git checkout branch fix-bug-name
- now write your patch.
- Check out your changes:
gulp test
gulp serve
- Commit and push your changes to your repo:
git commit $FILE-YOU-CHANGED -m "fixes widget bug #0000
git push
- If your changes are ready, test them and submit your pull request.
I used more or less the method I use myself for development in my fork of the repo. The prior instructions were lacking, and it still has no CONTRIBUTING.md, but that will be a separate issue.
Posted on Utopian.io - Rewarding Open Source Contributors