CONTRIBUTING.md

Contribution Guidelines

1. Get the source code:

Download souce code as zip

or use git clone https://github.com/impetus-opensource/Kundera.git

2. Discuss with Kundera Team:

Share your thoughts with us at Gitter chat or mail us at [email protected]

After discussion, Raise a new issue on github.

Code Recommendations

• Add proper javadocs and comments.
• Contributed code must pass existing test cases.
• Write new test cases using junit.
• For Eclipse: use Kundera Formatter.
• We recommend contributor to use Java 8.

3. Code Submission and Review:

The contributor needs to open a pull request on the trunk and get it reviewed by Kundera developers.

The contributor needs to incorporate code changes (if any).

4. Wiki:

The contributor needs to write wiki page(s) talking about usage. Check wiki for Kudu Client.

At any point feel free to contact.

Contribution Ideas

Sample Projects

Create sample projects using Kundera. For example, you can create a sample web application using Spring. Check existing examples.

Fix open issues

Check list of open issues.

Add support for new data source

Check Kundera supported databases and Kundera's Client Extension Framework for technical details on adding a new datasource. Check out our newly created Kudu client and it's wiki to get an idea of the source code as Kudu client has fewer features so it's easier to understand.