#361 Adding CONTRIBUTING.md and moving content from README.md over.

cflint · Jul 25, 2017 · 96c3d49 · 96c3d49
1 parent 4de84b5
commit 96c3d49
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 5 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+![CFLint](/src/main/resources/CFLint-logo.jpg)
+
+Contributing to CFLint
+======================
+
+# Project and library organisation
+
+CFLint is a project developed and worked on by volunteers. When logging issues please be nice and considerate, we're here to help. We really appreciate fixes and improvements, feel free to talk to us and/or provide pull requests.
+
+/src/main contains the source code. Tests can be found in /src/test. CFLint relies heavily on the [CFParser](https://github.com/cfparser/cfparser) project as well as a bunch of 3rd party Java libraries.
+
+The master branch is considered our stable codebase. Most of the development happens in the dev branch resp. local development branches for specific issues.
+
+# How to contribute?
+
+The main repository of this project is https://github.com/cflint/CFLint.
+
+Please fork from there, create a local dev branch from origin/dev (named so that it explains the work in the branch), and submit a pull request against the main repository's dev branch. Even better, get in touch with us here on Github before you undertake any work so that it can be coordinated with what we're doing.
+
+If you're interested in contributing on a regular basis, get in touch with [Ryan](https://github.com/ryaneberly) and we can add you to the internal CFLint Slack team.
diff --git a/README.md b/README.md
@@ -475,11 +475,7 @@ The [CFML Slack team](http://cfml-slack.herokuapp.com/) has a #cflint channel yo
 
 # How to contribute?
 
-The main repository of this project is https://github.com/cflint/CFLint.
-
-Please fork from there, create a local dev branch from origin/dev (named so that it explains the work in the branch), and submit a pull request against the main repository's dev branch. Even better, get in touch with us here on Github before you undertake any work so that it can be coordinated with what we're doing.
-
-If you're interested in contributing on a regular basis, get in touch with [Ryan](https://github.com/ryaneberly) and we can add you to the internal CFLint Slack team.
+See CONTRIBUTING.md for further information
 
 
 # Interesting 3rd-party projects