CONTRIBUTING.md

Contributing to INTIA

First off, thanks for taking the time to contribute!

Following is are the relevant informations that you need to contribute to this project.

Table of Contents

• Code of conduct
• Important resources
• How can I contribute?
  • Code contribution
  • Bug reports
  • Feature requests

Code of conduct

This project and everyone participating in it should obey to the Code of Conduct. Please report unacceptable behavior to [email protected]

Important resources

• Description of the underlying research project

How can I contribute?

There are many ways to contribute, from writing tutorials, blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the project itself.

Code contribution

Choose an issue you want to do. Before you start to work on an issue make sure to communicate your intend, so that the work is not done twice. You can do so, by writing a comment in the issue.

Note: When working on an issue it is helpfull to use the issue number in the branch name e.g. #23-fix-bug-XY. After fullfilling the issue, please send a pull request following the existing template and make sure that all checkboxes are marked. Also make sure that the associated commit message is understandable.

Bug reports

Have you seen a bug?

• Open up a bug issue
• Describe as good as you can the bug and how to reproduce it

Feature requests

Is there a feature missing? Create an issue for it and describe what is missing and how it should work.