From 48a3e63c4e78dc9d95f03ee235c67f6c7021879b Mon Sep 17 00:00:00 2001 From: Michal Papis Date: Wed, 15 Jan 2014 20:40:27 +0100 Subject: [PATCH] add separate file with rules of contributing --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ README.md | 10 +--------- 2 files changed, 27 insertions(+), 9 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3d3644b --- /dev/null +++ b/CONTRIBUTING.md @@ -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). diff --git a/README.md b/README.md index 5bbec99..dc731df 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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)