Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

55 lines (34 loc) · 2.84 KB
Raw

Contributing to ami

Thank you for taking the time to contribute! 👍

This is a set of guidelines for contributing to ami. You don't need to follow them as strict rules, use your best judgement and feel free to propose changes to this document as well via a pull request.

Table of Contents

Basics

How can I contribute?

Local testing

Basics

ami is built in Java. If you want an introduction on how to work on a project like this, you can find a beginners tutorial here.

How can I contribute?

Report bugs

If you encounter a bug, please let us know. You can raise a new issue here. Please include as many information in your report as possible, to help maintainers reproduce the problem.

  • A clear and descriptive title
  • Describe the exact steps which reproduce the problem, e.g. the query you entered.
  • Describe the behaviour following those steps, and where the problem occurred.
  • Explain where it was different from what you expected to happen.
  • Attach additional information to the report, such as error messages, or corrupted files.
  • Add a bug label to the issue.

Before submitting a bug, please check the list of existing bugs whether there is a similar issue open. You can then help by adding your information to an existing report.

Fixing bugs or implementing new features

If you're not sure where to start, have a look at issues that have a help wanted label - here is a list.

Suggesting features or changes

There is always room for improvement and we'd like to hear your perspective on it.

Before creating a pull request, please raise an issue to discuss the proposed changes first. We can then make sure to make best use of your efforts.

Local testing

In order to set up your development environment for ami, you need a recent verion of Java (at least 1.8), and Maven 3.

  1. Create a fork on github.
  2. Create a new branch with a descriptive name.
  3. Work on your changes, and make regular commits to save them.
  4. Test your changes:
  5. build with mvn clean install
  6. check error logs and if necessary review test outputs
  7. When your changes work as intended, push them to your repository and create a pull request.
  8. We will then review the pull request and merge it as soon as possible. If problems arise, they will be discussed within the pull request.