Skip to content
This repository has been archived by the owner on Jun 1, 2022. It is now read-only.

Latest commit

 

History

History
58 lines (35 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 3.73 KB
Raw

Contributing

Thank you in showing interest in contributing to Tony! We greatly value every contribution from

  • fixing a syntax error, improving style or adding a paragraph;
  • adding to the documentation;
  • reporting a bug;
  • implementing a feature; to
  • suggesting a new feature.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

Contributing ideas and reporting bugs

We use GitHub issues as a ticket system. You should open an issue if

You should not open an issue if

  • you want to report a security vulnerability. In that case please reference the security policy; or
  • you have a question. If you have a question use Stack Overflow instead or send an email to the project team at jonas.huebotter@gmail.com.
  • you want to fix a syntax error or adjust a sentence in the documentation. You may immediately propose your changes in a pull request.

When you open an issue we urge you to use the provided templates.

Contributing code

We appreciate your interest in contributing code. We flag issues we seek help with with the help wanted label. Issues that are good for first-time contributors are flagged with the good first issue label.

If you want to contribute code for an issue that is not flagged with one of these labels, ask kindly in the relevant issue. We will most likely appreciate your help with these tickets as well. Bear in mind that in this case, working on the ticket might require a little more direct communication beforehand.

In case you have any questions on an issue you want to take over don't hesitate to tag an owner of this project in your question in the issue timeline.

If you want to contribute code on something that doesn't have a belonging issue yet, please open an issue first.

Writing and testing code

The Tony project uses a variety of linters and automatic formatters to enforce code style and detect semantic problems with your code. These linters are run with every pull request you open (and subsequent commit you push). Please reference the readme and .github/workflows/ci.yml for details on which linters we use and on how to run them locally.

Furthermore, we strongly encourage you to write tests for every change you propose that affects actual code. Details on how tests are run can also be found in the readme.

Submitting a pull request

Once you're happy with your changes, you are ready to submit your pull request.

Please keep your description short and succinct, but explain what changes you made and - if applicable - why you made those changes. The more descriptive your summary is, the more likely it is for your changes to be merged quickly. Don't forget to reference the issue this pull request addresses.

Don't be taken aback if your pull request is not merged immediately. Most pull requests take a couple of rounds of iteration until everyone is happy with all changes made.

Once your pull request got merged, we're absolutely delighted to welcome you as a contributor to the Tony project!