Skip to content

Commit 23b054e

Browse files
committed
Further tweaks to contribution guidelines and templates.
1 parent 5a94055 commit 23b054e

File tree

3 files changed

+22
-17
lines changed

3 files changed

+22
-17
lines changed

CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Contributing
2+
3+
We greatly value the feedback and contributions of our users. We have a simple process in place to facilitate this:
4+
5+
### Bugs and New Features
6+
7+
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:
8+
9+
- User Issues can be raised in our [User Issues Room](https://gitter.im/sdkman/user-issues).
10+
- New Features or Enhancements can be discussed in our [CLI Development Room](https://gitter.im/sdkman/cli-dev).
11+
12+
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).
13+
14+
**Unfortunately we will close any Github Issues that have not followed this process of prior discussion.**
15+
16+
### Pull Requests
17+
18+
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.
19+
20+
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.

PULL_REQUEST_TEMPLATE.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ To raise a new Pull Request, the following prerequisites need to be met. Please
22

33
- [ ] a conversation was held in the appropriate Gitter Room.
44
- [ ] a Github Issue was opened for this feature / bug.
5+
- [ ] test coverage was added (Cucumber or Spock as appropriate).
56

6-
Please link to a Github Issue by replacing XXX appropriately:
7-
8-
Issue #XXX
7+
This addresses Issue #XXX

README.md

-14
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,6 @@ Open your favourite terminal and enter the following:
1717

1818
If the environment needs tweaking for SDKMAN to be installed, the installer will prompt you accordingly and ask you to restart.
1919

20-
## Contributions
21-
22-
### Bugs and New Features
23-
24-
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).
25-
26-
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).
27-
28-
**Unfortunately we will close any Github Issues that have not followed this process.**
29-
30-
### Pull Requests
31-
32-
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.
33-
3420
## Running the Cucumber Features
3521

3622
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:

0 commit comments

Comments
 (0)