You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-12Lines changed: 17 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,6 @@ SDKMAN is a tool for managing parallel Versions of multiple Software Development
9
9
10
10
See documentation on the [SDKMAN! website](http://sdkman.io).
11
11
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
-
17
12
## Installation
18
13
19
14
Open your favourite terminal and enter the following:
@@ -22,19 +17,29 @@ Open your favourite terminal and enter the following:
22
17
23
18
If the environment needs tweaking for SDKMAN to be installed, the installer will prompt you accordingly and ask you to restart.
24
19
25
-
## Running the Cucumber Features
20
+
## Contributions
26
21
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
29
23
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.**
31
29
30
+
### Pull Requests
32
31
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
34
39
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:
0 commit comments