Further tweaks to contribution guidelines and templates.

sdkman · Aug 26, 2017 · 7ee2c51 · 7ee2c51
1 parent 5a94055
commit 7ee2c51
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 17 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+## Contributing
+
+We greatly value the feedback and contributions of our users. We have a simple process in place to facilitate this:
+
+### Bugs and New Features
+
+We keep a distinction between New Features and Bugs/Issues. We try to minimise the noise in our Github Issues stream by first having a conversation in one of the following [Gitter](https://gitter.im/) Rooms:
+
+- User Issues can be raised in our [User Issues Room](https://gitter.im/sdkman/user-issues).
+- New Features or Enhancements can be discussed in our [CLI Development Room](https://gitter.im/sdkman/cli-dev).
+
+After accepting a new feature or confirming that a bug was found, an Issue may be raised filling in the provided Issue Template on the [GitHub Issue Tracker](https://github.com/sdkman/sdkman-cli/issues/new).
+
+**Unfortunately we will close any Github Issues that have not followed this process of prior discussion.**
+
+### Pull Requests
+
+Pull Requests are _always_ very welcome, but require the initial discussion on Gitter followed by a Github Issue as described above. The PR template is to be filled in before submission, ensuring that it is _linked back_ to the Github Issue number by replacing `#XXX` with the appropriate Issue reference.
+
+Each PR should also be accompanied by a passing test(s) proving it's validity (where feasible). The feasibility of the test will emerge in the initial discussions on Gitter and in the Github Issue.
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -2,7 +2,6 @@ To raise a new Pull Request, the following prerequisites need to be met. Please
 
 - [ ] a conversation was held in the appropriate Gitter Room.
 - [ ] a Github Issue was opened for this feature / bug.
+- [ ] test coverage was added (Cucumber or Spock as appropriate).
 
-Please link to a Github Issue by replacing XXX appropriately:
-
-Issue #XXX
+This addresses Issue #XXX
diff --git a/README.md b/README.md
@@ -17,20 +17,6 @@ Open your favourite terminal and enter the following:
 
 If the environment needs tweaking for SDKMAN to be installed, the installer will prompt you accordingly and ask you to restart.
 
-## Contributions
-
-### Bugs and New Features
-
-User Issues can be raised in our [Gitter Room for User Issues](https://gitter.im/sdkman/user-issues). Similarly, new features can be discussed in our [CLI Development Room](https://gitter.im/sdkman/cli-dev).
-
-After accepting a new feature or confirming that a bug was found, an Issue may be raised filling in the provided Issue Template on the [GitHub Issue Tracker](https://github.com/sdkman/sdkman-cli/issues).
-
-**Unfortunately we will close any Github Issues that have not followed this process.**
-
-### Pull Requests
-
-Pull requests are always very welcome, but require an initial discussion on Gitter followed by a Github Issue as described above. Once this has been completed, _a PR can be raised and linked to the Github Issue_. All PRs should be accompanied by a passing test(s) proving it's validity (where feasible). The feasibility of the test will emerge in the initial discussions on Gitter and in the Github Issue.
-
 ## Running the Cucumber Features
 
 All SDKMAN's BDD tests describing the CLI behaviour are written in Cucumber and can be found under `src/test/cucumber/sdkman`. These can be run with Gradle by running the following command: