Skip to content

Commit 83b4083

Browse files
committed
#19 Added .sdkmanrc and instructions on how to use it
Signed-off-by: Kaur Palang <kaur.palang@brightcodecompany.com>
1 parent 9adf3f3 commit 83b4083

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

.sdkmanrc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Enable auto-env through the sdkman_auto_env config
2+
# Add key=value pairs of SDKs to use below
3+
java=8.0.442.fx-zulu
4+
ant=1.10.14

CONTRIBUTING.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,19 @@ Create a new branch for your feature or bug fix:
2424
```bash
2525
git checkout -b feature/your-feature-name
2626
```
27-
Implement the necessary changes, ensuring that they align with the project’s coding standards and practices.
2827

29-
### 5. Test Your Changes
28+
### 5. Install Tooling
29+
OIE specifies the working versions of Java and Ant in [.sdkmanrc](./.sdkmanrc). To take advantage of this, install [SDKMAN](https://sdkman.io/) and run `sdk env install`
30+
in the project's root directory.
31+
32+
### 6. Implement your changes
33+
34+
Implement the necessary changes, ensuring they align with the project’s coding standards and practices.
35+
36+
### 7. Test Your Changes
3037
Before submitting your changes, please ensure that all tests pass and that your changes work as expected in your local environment.
3138

32-
### 6. Submit a Pull Request
39+
### 8. Submit a Pull Request
3340
Once your changes are ready, push them to your fork and create a **draft pull request (PR)** from your branch to the `main` branch of the project. Draft PRs help indicate that the work is in progress.
3441
Mark the PR as **"Ready for review"** only when it is actually complete and ready for feedback. Include a brief description of the changes and reference the related issue.
3542

0 commit comments

Comments
 (0)