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
-[Your First Code Contribution](#your-first-code-contribution)
20
18
-[Improving The Documentation](#improving-the-documentation)
21
-
-[Styleguides](#styleguides)
22
-
-[Commit Messages](#commit-messages)
19
+
-[Naming Convention](#naming-convention)
23
20
-[Join The Project Team](#join-the-project-team)
24
21
25
22
@@ -98,29 +95,34 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/lambda
98
95
- Use a **clear and descriptive title** for the issue to identify the suggestion.
99
96
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
100
97
-**Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
101
-
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.<!-- this should only be included if the project has a GUI -->
98
+
- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux.
102
99
-**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.
103
100
104
101
### Your First Code Contribution
105
-
TODO
106
-
<!-- TODO
107
-
include Setup of env, IDE and typical getting started instructions?
102
+
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)
108
103
109
-
-->
104
+
This is required for pull requests to be accepted, or even reviewed.
110
105
111
-
### Improving The Documentation
112
-
TODO
113
-
<!-- TODO
114
-
Updating, improving and correcting the documentation
106
+
You will need the following before contributing:
107
+
- GitHub CLI / Desktop
108
+
- IntelliJ IDEA
109
+
- Java 17 SDK
110
+
-[Minecraft Development Plugin](https://plugins.jetbrains.com/plugin/8327-minecraft-development)
111
+
112
+
After you have everything you can do the following:
113
+
- Clone the repository `git clone https://github.com/lambda-client/lambda`
114
+
- Open the project, **inside the project folder**, in IntelliJ IDEA
115
+
- Set the java runtime in `File > Project Structure > SDK > JDK 17`
116
+
- Wait for Gradle to resolve dependencies and to set up the project.
117
+
- And you should now be able to run the project using the [run configurations](https://www.jetbrains.com/help/idea/run-debug-configuration.html)
115
118
116
-
-->
119
+
### Improving The Documentation
120
+
If you believe that some documentation can be improved or added, please discuss with us on our [Discord](https://discord.gg/QjfBxJzE5x)
117
121
118
-
## Styleguides
119
-
### Commit Messages
120
-
TODO
121
-
<!-- TODO
122
+
### Naming Convention
123
+
We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for the Lambda project.
122
124
123
-
-->
125
+
Feel free to propose additional compatible naming conventions.
124
126
125
127
## Join The Project Team
126
128
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.
stale-issue-message: 'This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.'
17
+
stale-pr-message: 'This PR is stale because it has been open 60 days with no activity.'
0 commit comments