Development Guidelines

This page links to guidelines that you should follow when contributing the Chimera project.

IDE configuration - this guidelines describes how to configure your IDE to use the correct code formatting and to connect to Sonarqube, which displays checks the code for potential bugs and code smells. Please make sure, that your IDE is configured according to our policy, before you start coding.

Development process - this guideline describes the development process, especially how to use github and its features. It covers feature branches and pull requests, how to write useful commit messages and github issues, and how to release new versions of Chimera. Please check this resource, before you commit to Chimera.

Styleguides - this page explains the style that the Chimera project uses for the source code, commit messages, and Github issues. Please stick to the style when contributing to Chimera.

Testing Chimera - this guidelines provides information on writing tests and the usage of the test database. Please create tests for new features following this guideline.

Troubleshooting - this guide lists common errors and problems with Chimera and helps solving them. It is a work in progress. Please report your errors, so we can extend the troubleshooting guide. Please consult this guide before submitting a bug report.

Debugging Chimera - this guide explains how to find and (hopefully) fix bugs.