From 36b08b551c8c5fc15d16fda14c3ab1defe361f7b Mon Sep 17 00:00:00 2001 From: Damien GERARD Date: Wed, 24 Jun 2015 13:27:01 +0200 Subject: [PATCH] updated CONTRIBUTING.md (closes #241) Trying to provide a simple workflow for accepting pull requets --- CONTRIBUTING.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 550bd6187..ebdebadbe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,25 @@ -#Contributing +# Contributing Your pull requests are welcome; however, they may not be accepted for various reasons. -##Guidelines for pull requests: + + + +## Before you contribute + +All Pull Requests, except for translations and user documentation, need to be +attached to a issue on GitHub. For Pull Requests regarding enhancements and questions, +the issue must first be approved by one of project's administrators before being +merged into the project. An approved issue will have the label `Accepted`. For issues +that have not been accepted, you may request to be assigned to that issue. + +Opening a issue beforehand allows the adminstrators and the communitiy to discuss +bugs and enhancements before work begins, preventing wasted effort. + + + + +## Guidelines for pull requests: 1. Respect Notepad++ coding style. 2. Make a single change per commit. @@ -13,6 +30,9 @@ Your pull requests are welcome; however, they may not be accepted for various re In short: The easier the code review is, the better the chance your pull request will get accepted. + + + ##Coding style: ####GENERAL