-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the CONTRIBUTION.md to conform with our current status and CLA process
- Loading branch information
Showing
1 changed file
with
23 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,38 @@ | ||
| # Contribution guidelines | ||
| # Contribution Guidelines | ||
|
|
||
| Thank you for your interest in contributing to the Axon Framework. To make sure using Axon is a smooth experience for | ||
| everybody, we've set up a number of guidelines to follow. | ||
| Thank you for your interest in contributing to the Axon Framework Reactor Extension. To make sure using Axon is a smooth | ||
| experience for everybody, we've set up a number of guidelines to follow. | ||
|
|
||
| There are different ways in which you can contribute to the framework: | ||
|
|
||
| 1. You can report any bugs, feature requests or ideas about improvements on our issue page: https://github.com/AxonFramework/extension-reactor/issues. | ||
| All ideas are welcome. Please be as exact as possible when reporting bugs. This will help us reproduce and thus solve | ||
| the problem faster. | ||
| 1. If you have created a component for your own application that you think might be useful to include in the | ||
| framework, send us a pull request (or patch or a zip containing the source code). We will evaluate it and try to | ||
| fit it in the framework. Please make sure code is properly documented using javadoc. This helps us to understand | ||
| what is going on. | ||
| 1. If you know of any other way you think you can help us, do not hesitate to send a message to the | ||
| [AxonIQ's discussion platform](https://discuss.axoniq.io/). | ||
| 1. You can report any bugs, feature requests or ideas about improvements on | ||
| our [issue page](https://github.com/AxonFramework/extension-reactor/issues/new/choose). All ideas are welcome. Please | ||
| be as exact as possible when reporting bugs. This will help us reproduce and thus solve the problem faster. | ||
| 2. If you have created a component for your own application that you think might be useful to include in the framework, | ||
| send us a pull request (or a patch / zip containing the source code). We will evaluate it and try to fit it in the | ||
| framework. Please make sure code is properly documented using JavaDoc. This helps us to understand what is going on. | ||
| 3. If you know of any other way you think you can help us, do not hesitate to send a message to | ||
| the [AxonIQ's discussion platform](https://discuss.axoniq.io/). | ||
|
|
||
| ## Code contributions | ||
| ## Code Contributions | ||
|
|
||
| If you're contributing code, please take care of the following: | ||
|
|
||
| ### Contributor Licence Agreement | ||
|
|
||
| To keep everyone out of trouble (both you and us), we require that all contributors (digitally) sign a Contributor | ||
| License Agreement. Basically, the agreement says that we may freely use the code you contribute to the Axon Framework, | ||
| and that we won't hold you liable for any unfortunate side effects that the code may cause. | ||
| License Agreement. Basically, the agreement says that we may freely use the code you contribute to the Axon Framework | ||
| Reactor Extension, and that we won't hold you liable for any unfortunate side effects that the code may cause. | ||
|
|
||
| To sign the CLA, visit: https://www.clahub.com/agreements/AxonFramework/extension-reactor. | ||
| To sign the CLA, visit: https://cla-assistant.io/AxonFramework/extension-reactor | ||
|
|
||
| ### Code style | ||
|
|
||
| We're trying very hard to maintain a consistent style of coding throughout the code base. Think of things like | ||
| indenting using 4 spaces, putting opening brackets (the '{') on the same line and putting proper Javadoc on all | ||
| non-private members. | ||
|
|
||
| If you're using IntelliJ IDEA, you can download the code style definition from | ||
| http://www.axonframework.org/axon_code_style.xml. Simply copy the file to ~/.IntelliJIdea13/config/codestyles. After | ||
| (re)starting IntelliJ, you can pick this code style from the project settings. | ||
| ### Code Style | ||
|
|
||
| We're trying very hard to maintain a consistent style of coding throughout the code base. Think of things like indenting | ||
| using 4 spaces, putting opening brackets (the '{') on the same line and putting proper JavaDoc on all non-private | ||
| members. | ||
|
|
||
| If you're using IntelliJ IDEA, you can download the code style | ||
| definition [here](https://github.com/AxonFramework/AxonFramework/blob/master/axon_code_style.xml). Simply import the XML | ||
| file in under "Settings -> Code Style -> Scheme -> Import Scheme". Doing so should make the code style selectable | ||
| immediately. |