Skip to content

Commit 0e4260b

Browse files
committed
Update CONTRIBUTING.md
1 parent e9b6ecf commit 0e4260b

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

.github/CONTRIBUTING.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -102,25 +102,25 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/lambda
102102
- **Explain why this enhancement would be useful** to most Lambda users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
103103

104104
### Your First Code Contribution
105-
TODO
106-
<!-- TODO
107-
include Setup of env, IDE and typical getting started instructions?
105+
First of all, make sure to read or simply check the [Official Kotlin Coding Convention](https://kotlinlang.org/docs/coding-conventions.html#control-flow-statements)
108106

109-
-->
107+
This is required for pull requests to be accepted, or even reviewed.
110108

111-
### Improving The Documentation
112-
TODO
113-
<!-- TODO
114-
Updating, improving and correcting the documentation
115-
116-
-->
109+
You will need the following before contributing:
110+
- GitHub CLI / Desktop
111+
- IntelliJ IDEA
112+
- Java 17 SDK
113+
- [Minecraft Development Plugin](https://plugins.jetbrains.com/plugin/8327-minecraft-development)
117114

118-
## Styleguides
119-
### Commit Messages
120-
TODO
121-
<!-- TODO
115+
After you have everything you can do the following:
116+
- Clone the repository `git clone https://github.com/lambda-client/lambda`
117+
- Open the project, **inside the project folder**, in IntelliJ IDEA
118+
- Set the java runtime in `File > Project Structure > SDK > JDK 17`
119+
- Wait for Gradle to resolve dependencies and to set up the project.
120+
- And you should now be able to run the project using the [run configurations](https://www.jetbrains.com/help/idea/run-debug-configuration.html)
122121

123-
-->
122+
### Improving The Documentation
123+
If you believe that some documentation can be improved or added, please discuss with us on our [Discord](https://discord.gg/QjfBxJzE5x)
124124

125125
## Join The Project Team
126126
Most communication happens on our [Discord](https://discord.gg/QjfBxJzE5x). You can join the project team by contributing to the project. The project team is responsible for reviewing and merging pull requests, and they will help you at every step of the way.

0 commit comments

Comments
 (0)