Skip to content

Commit

Permalink
docs(contributing): update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
vvo committed Sep 22, 2015
1 parent 45b8908 commit d84af23
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,41 @@
Hi collaborator!

We use **pull request** based approach to development.

**Have a fix or a new feature**? Search for corresponding issues first then
create a new one.

If you have a new **API proposal** or change, create an issue describing it precisely:
- JavaScript example
- Resulting DOM/effect

Once **you are ready** to start working:
- **assign** the task to yourself
- **create a branch** starting from the **develop** branch
- see [development workflow](#development-workflow)
- use our [commit message guidelines](#commit-message-guidelines) to provide a meaningful commit message (it will be inserted into the changelog automatically)
- add a [#fix #issue](https://help.github.com/articles/closing-issues-via-commit-messages/) when relevant
- **submit** your pull request to the develop branch
- wait for **review**
- do the necessary changes
- **rebase** your pull request to avoid commits like "fix dangling comma in bro.js", "fix after review"

# Development workflow

Rapidly iterate with our example app:

```sh
npm install
npm run dev
```

# Test and lint
Run the tests and lint:

```sh
npm test
```

# Commits guidelines
# Commit message guidelines

We use [conventional changelog](https://github.com/ajoslin/conventional-changelog),
please [follow the rules for committing](https://github.com/ajoslin/conventional-changelog/blob/master/conventions/angular.md), it helps reducing the commit noise.
Expand Down

0 comments on commit d84af23

Please sign in to comment.