First off, thanks for taking time to contribute!
The following is a set of guidelines for contributing to the Yorc plugin for alien4cloud. Feel free to provide feedback about it in an issue or pull request.
Don't be afraid to contribute, if something is unclear then just ask or submit the issue or pull request anyways. The worst that can happen is that you'll be politely asked to change something.
Java JDK 1.8+ and maven 3+ are required to build the project.
Sphinx and make are required to build the documentation.
Here is how to install and setup the Yorc plugin project:
sudo apt-get install build-essential git curl
# Or
sudo yum install build-essential git curl
# Install Go and set GOPATH
git clone https://github.com/ystia/yorc-a4c-plugin.git
cd yorc-a4c-plugin
# Build
mvn clean install
You can contribute to the Yorc project in several ways. All of them are welcome.
- Report a documentation issue
- Report a bug
- Report an improvement request
- Propose a PR that fixes one of the above, we will try to tag
good_first_prissues that are a good starting point for contributing
Use Github issues to report issues. Please try to answer most of the questions asked in the issue template.
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
Use Github pull requests to propose a PR. Please try to answer most of the questions asked in the pull request template.
You should apply the license header to the source files. This is enforced by the maven build.
To automatically apply the license header use mvn com.mycila:license-maven-plugin:format