CONTRIBUTING.md

Contributing to Chan

Issue Contributions

When opening new issues or commenting on existing issues on this repository please make sure discussions are related to concrete technical issues.

Try to be friendly (we are not animals 🐒 or bad people ) and explain correctly how we can reproduce your issue.

Code Contributions

This document will guide you through the contribution process.

Step 1: Fork

Fork the project on GitHub and check out your copy locally.

$ git clone git@github.com:username/chan.git
$ cd chan
$ npm install
$ git remote add upstream git://github.com/geut/chan.git

How can I run the project and test my ideas?

$ npm run watch
$ npm link

Now you can execute chan from your terminal.

Which branch?

For developing new features and bug fixes, the master branch should be pulled and built upon.

Step 2: Branch

Create a feature branch and start hacking:

$ git checkout -b my-feature-branch -t origin/master

Step 3: Test

Bug fixes and features should come with tests. We use AVA to do that.

$ npm test

Make sure the linter is happy and that all tests pass. Please, do not submit patches that fail either check.

Step 4: Commit

Make sure git knows your name and email address:

$ git config --global user.name "J. Random User"
$ git config --global user.email "j.random.user@example.com"

Writing good commit logs is important. A commit log should describe what changed and why.

Step 5: Push

$ git push origin my-feature-branch

Step 6: Make a pull request ;)