Skip to content

Commit

Permalink
Merge 48a3e63 into 6ba41b8
Browse files Browse the repository at this point in the history
  • Loading branch information
mpapis committed Jan 15, 2014
2 parents 6ba41b8 + 48a3e63 commit 16db00a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 9 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

## Reporting issues

Please provide as much details as possible.

### Closing old issues

Tickets that require user feedback will be marked with `need-info`
label. In case there will be no feedback on such ticket in two
months we will close that ticket. the ticket will be reopened as
soon as user can provide requested information.

## Adding extra check plugins

You can add extra checks by creating gem with a new check in
`lib/plugins/pre_commit/checks/`, check this project directory for
examples:
[lib/plugins/pre_commit/checks](lib/plugins/pre_commit/checks).

## Adding extra configuration provider plugins

You can add extra providers by creating gem with a new provider in
`lib/plugins/pre_commit/configuration/providers/`, check this
project directory for examples:
[lib/plugins/pre_commit/configuration/providers](lib/plugins/pre_commit/configuration/providers).
10 changes: 1 addition & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,6 @@ These are the available checks:

Use `pre-commit list` to see the list of default and enabled checks and warnings.

### Adding extra check plugins

You can add extra checks by creating gem with a new check in `lib/plugins/pre_commit/checks/`,
check this project directory for examples: [lib/plugins/pre_commit/checks](lib/plugins/pre_commit/checks).

## Enabling / Disabling Checks / Warnings

Usage:
Expand All @@ -78,7 +73,4 @@ git commit -m "pre-commit: move jshint from checks to warnings"
- `git` - reads configuration from `git config pre-commit.*`, allow local update
- `yaml` - reads configuration from `/etc/pre-commit.yml`, `$HOME/.pre-commit.yml` and `config/pre-commit.yml`, allows `config/pre-commit.yml` updates

### Adding extra configuration provider plugins

You can add extra providers by creating gem with a new provider in `lib/plugins/pre_commit/configuration/providers/`,
check this project directory for examples: [lib/plugins/pre_commit/configuration/providers](lib/plugins/pre_commit/configuration/providers).
## [Contributing](CONTRIBUTING.md)

0 comments on commit 16db00a

Please sign in to comment.