Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.43 KB

Contributing to GROOPS

We appreciate all contributions from improving the documentation to providing bug fixes and implementing new features.

Before you start coding, please get in contact with us. The best way to do so is by filing an issue.

Getting Started

Improving Documentation and Examples

Please inform us about your intention to work on the documentation by creating an issue.

When your contribution is finished, please submit a Pull Request (PR) to https://github.com/groops-devs/groops.

Your contribution will then be reviewed.

Reporting Bugs

If you encounter a bug, please let us know by filing an issue. Please include as much information as possible on how to reproduce the bug and about your software environment (operating system, compiler version, GROOPS version).

Implementing New Features

Create an issue and we will discuss together how to best integrate the new functionality into the existing code base. Once we together agree on a way forward, you can go ahead and implement it.

When your contribution is implemented and tested, please submit a Pull Request (PR) to https://github.com/groops-devs/groops.

Your contribution will then be reviewed.

Reviewing large PRs is difficult and will take time, so please be patient.