Skip to content

Latest commit

 

History

History
35 lines (20 loc) · 1.69 KB

CONTRIBUTE.md

File metadata and controls

35 lines (20 loc) · 1.69 KB

Contributing

Thanks for your interest! We appreciate any contribution to the project. This document tries to help you get started. If you have questions please write me a mail (see profile).

Feature Requests / Bug reports

Is there a feature you would like to see in a future release? Or have you found a bug? Create a new issue and give describe it as good as possible.

Code

You want to contribute code? Great! Look for issues with the following labels, depending on what you are looking for:

  • first-timer-only:

To quote firsttimersonly.com: "I'm willing to hold your hand so you can make your first PR. This issue is rather a bit easier than normal. And anyone who's already contributed to open source isn't allowed to touch this one!"

  • up-for-grabs:

This issues should be easy to solve and are great to start if you already have contributed to OSS before and are new here.

  • mentor:

This means that I can provide you additional information to help getting started and a basic idea how to solve this.

For any issue regardless of the label I want to encourage you to ask if there are any questions. I'm happy to help.

Pull Requests

Pull requests are the primary mechanism we use to change something on the Money Fox. There is a detailed documentation on using pull requests by GitHub itself.

Please make pull requests against the master branch.

Also, please ensure you have unit tests written for your changes where possible and that all existing tests are still running.

Getting Started

Have a look at our [Getting Started] (https://github.com/MoneyFox/MoneyFox/wiki/Getting-Started) page in our wiki.