Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.59 KB

Contributing Guide of Mechkit

Thank you for investing your time in contributing to this project! Please follow the Code of Conduct to keep the community approachable and respectable. In this guide you will get an overview of the contribution workflow.

New Contributor Guide

To get an overview of the project, read the README. Github offers the following resources to help you get started with open source contributions:

Bugs / Issues

We don't like bugs, and are therefore grateful for any possibility to fix them. Please report any problems by opening an issue. Screenshots as well as minimal working examples are highly appreciated, as they ease the understanding of the problem.

Workflow: Fork -> Modify -> Test -> Pull Request

The main goal of the project is the reuse of research code to increase the reliability of research results and to accelerate and simplify further research. This objective implies the need for continuous extension and improvement. As a consequence, code contributions of any kind are welcome.

Please

  • fork the repository,
  • modify and extend the code in your personal fork,
  • run tests,
  • open a pull request to incorporate your changes into original the project after review.