|
| 1 | +# Contribution Guidelines |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the Axon Framework Kotlin Extension. To make sure using Axon is a smooth |
| 4 | +experience for everybody, we've set up a number of guidelines to follow. |
| 5 | + |
| 6 | +There are different ways in which you can contribute to the framework: |
| 7 | + |
| 8 | +1. You can report any bugs, feature requests or ideas about improvements on |
| 9 | + our [issue page](https://github.com/AxonFramework/extension-kotlin/issues/new/choose). All ideas are welcome. Please |
| 10 | + be as exact as possible when reporting bugs. This will help us reproduce and thus solve the problem faster. |
| 11 | +2. If you have created a component for your own application that you think might be useful to include in the framework, |
| 12 | + send us a pull request (or a patch / zip containing the source code). We will evaluate it and try to fit it in the |
| 13 | + framework. Please make sure code is properly documented using JavaDoc. This helps us to understand what is going on. |
| 14 | +3. If you know of any other way you think you can help us, do not hesitate to send a message to |
| 15 | + the [AxonIQ's discussion platform](https://discuss.axoniq.io/). |
| 16 | + |
| 17 | +## Code Contributions |
| 18 | + |
| 19 | +If you're contributing code, please take care of the following: |
| 20 | + |
| 21 | +### Contributor Licence Agreement |
| 22 | + |
| 23 | +To keep everyone out of trouble (both you and us), we require that all contributors (digitally) sign a Contributor |
| 24 | +License Agreement. Basically, the agreement says that we may freely use the code you contribute to the Axon Framework |
| 25 | +Kotlin Extension, and that we won't hold you liable for any unfortunate side effects that the code may cause. |
| 26 | + |
| 27 | +To sign the CLA, visit: https://cla-assistant.io/AxonFramework/extension-kotlin |
| 28 | + |
| 29 | +### Code Style |
| 30 | + |
| 31 | +We're trying very hard to maintain a consistent style of coding throughout the code base. Think of things like indenting |
| 32 | +using 4 spaces, putting opening brackets (the '{') on the same line and putting proper JavaDoc on all non-private |
| 33 | +members. |
| 34 | + |
| 35 | +If you're using IntelliJ IDEA, you can download the code style |
| 36 | +definition [here](https://github.com/AxonFramework/AxonFramework/blob/master/axon_code_style.xml). Simply import the XML |
| 37 | +file in under "Settings -> Code Style -> Scheme -> Import Scheme". Doing so should make the code style selectable |
| 38 | +immediately. |
0 commit comments