Home

Welcome to the Crux contributor guide!

Thanks for your interest in contribute to Crux code.

Crux is an open source project and you are very welcome to contribute to it. Before start committing code to repository, check the project issue list to see what kind of help the project needs. Join our developers group list to discuss with other Crux developers the features roadmap and implementation details.

Every pull request to Crux repository is then reviewed by the project members. Accepted requests are merged to Crux repository.

When you send a contribution to our repository, you are accepting our terms and conditions, described below.

Thanks again for your interest and have a happy coding!

Contributor Guide

Before start contributing to Crux repository, you need to:

1. Accept our terms and conditions to became a Crux contributor

• Read here our contributors license agreement.

2. Configure your IDE to follow our code conventions

• Follow this guide if you are using Eclipse IDE.
• TODO - Help Wanted to document the process for other IDEs.

3. Create a GitHub account if you don't have one yet

To do this, just go to https://github.com/join and follow the process on this screen.

4. Fork the crux repository to your personal github space and then clone it

Follow this guide to see how to fork a crux repository and then clone it to your computer.

5. After change the code, commit it to your github repository

Please, read this guide about comments on code commits.

6. Create a Pull Request to submit your code to Crux repository

Please, read this guide about Pull Requests to the repository.