Skip to content

Commit 743ae61

Browse files
authored
Add Contributions section to README.
1 parent 2db598e commit 743ae61

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,6 @@ SDKMAN is a tool for managing parallel Versions of multiple Software Development
99

1010
See documentation on the [SDKMAN! website](http://sdkman.io).
1111

12-
User issues can be raised on our [Gitter Channel](https://gitter.im/sdkman/user-issues).
13-
After confirming that indeed a new bug was found, an Issue may be raised (as well as any new feature requests) on
14-
the [GitHub Issue Tracker](https://github.com/sdkman/sdkman-cli/issues).
15-
Unfortunately we will close any Github Issues that have not followed this process.
16-
1712
## Installation
1813

1914
Open your favourite terminal and enter the following:
@@ -22,19 +17,29 @@ Open your favourite terminal and enter the following:
2217

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

25-
## Running the Cucumber Features
20+
## Contributions
2621

27-
All SDKMAN's BDD tests are written in Cucumber and can be found under `src/test/cucumber/sdkman`.
28-
These can be run with Gradle by running the following command:
22+
### Bugs and New Features
2923

30-
$ ./gradlew test
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.**
3129

30+
### Pull Requests
3231

33-
__Please ensure that the JAVA_HOME environment variable is set to JDK 1.8 on your system!__
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+
34+
## Running the Cucumber Features
35+
36+
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:
37+
38+
$ ./gradlew test
3439

35-
Mac users can add the following line to their `~/.bash_profile` file to set this variable:
40+
To perform development, you will need to have a JDK 8 or higher installed which can be obtained by running the following after installing SDKMAN:
3641

37-
export JAVA_HOME=$(/usr/libexec/java_home -v1.8)
42+
$ sdk install java
3843

3944
### Using Docker for tests
4045

0 commit comments

Comments
 (0)