Skip to content
This repository has been archived by the owner on Apr 27, 2023. It is now read-only.

Commit

Permalink
docs(contributing): update contributing info
Browse files Browse the repository at this point in the history
  • Loading branch information
mike182uk committed Mar 6, 2016
1 parent 6f2be7c commit ba70d6d
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# Contributing

Contributions are **welcome** and will be fully **credited**.
Contributions are **welcome!**

Contributions can be made via a Pull Request on [Github](https://github.com/mike182uk/fetch-gists).

## Reporting an Issue

Please report issues via the issue tracker on [Github](https://github.com/mike182uk/fetch-gists). For security-related issues, please email the maintainer directly.

## Pull Requests

- **[Node coding style](https://github.com/felixge/node-style-guide)** - [JSCS](http://jscs.info/). Make sure you run `npm run sa` before committing your code.
- **[Node.js coding style](https://github.com/felixge/node-style-guide)** - [JSCS](http://jscs.info/), [JSHint](http://jshint.com/). Make sure you run `npm run sa` before committing your code.

- **Add tests where appropriate** - [Tape](https://github.com/substack/tape)

Expand All @@ -18,14 +22,20 @@ Contributions can be made via a Pull Request on [Github](https://github.com/mike

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

- **Use conventional-changelog style commit messages** - See [here](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) for more details. This project is [commitizen](https://commitizen.github.io/cz-cli/) friendly.

## Running Tests

You can run all of the tests in the project using:

```bash
npm test
```

## Running Static Analysis

You can run all of the static analysis tools used by the project using:

```bash
npm run sa
```

0 comments on commit ba70d6d

Please sign in to comment.