Add instructions for contributing patches.steemCreated with Sketch.

in #utopian-io7 years ago

Adds step-by-step instructions for contribution to README.md:

Getting Started

  1. Clone this repo:
    • git clone https://github.com/CrisisTextLine/CrisisTrends
  2. Install Gulp and other depends:
    • npm install -g gulp
    • npm install
  3. Start gulp server:
    • gulp serve

Start Coding

  1. Fork this repository.
  2. Clone the new fork:
    • git clone https://github.com/$YOUR-GITHUB-USER-NAME/CrisisTrends
  3. Set up depends:
    • npm install -g gulp
    • npm install
  4. Create a branch for your bugfix/feature/etc
    • git checkout branch fix-bug-name
    • now write your patch.
  5. Check out your changes:
    • gulp test
    • gulp serve
  6. 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

Sort:  

Your contribution cannot be approved yet because it does not have proof of work. See the Utopian Rules. Please edit your contribution and add proof (links, screenshots, commits, etc) of your work, to reapply for approval.

You may edit your post here, as shown below:

You can contact us on Discord.
[utopian-moderator]

Your contribution cannot be approved because it does not follow the Utopian Rules.

You can contact us on Discord.
[utopian-moderator]