From 36d512779607e19520e204f1155e2dae2464cb83 Mon Sep 17 00:00:00 2001 From: lupoDharkael Date: Sat, 3 Mar 2018 18:08:43 +0100 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..455f4887 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing + +Contributions are welcome! Here's how you can help: + +- [Translating](#translations) +- [Contributing code](#code) +- [Reporting issues](#issues) +- [Donating](#donations) + +## Translations +If you want to contribute with translations you should do it in [this repository](https://github.com/flameshotapp/translations) and not in the main repository of Flameshot. + +Read the description of that repository for more information. + +## Code + +1. [Fork](https://help.github.com/articles/fork-a-repo/) the repository and [clone](https://help.github.com/articles/cloning-a-repository/) your fork. + +2. Start coding! + - Implement your feature. + - Check your code works as expected. + +3. Commit your changes to a new branch (not `master`, one change per branch) and push it: + - Commit messages should: + - Header line: explain the commit in one line (use the imperative) + - Be descriptive. + - Have a first line with less than *80 characters* and have a second line that is *empty* if you want to add a description. + +4. Once you are happy with your changes, submit a pull request. + - Open the pull-request. + - Add a short description explaining briefly what you've done (or if it's a work-in-progress - what you need to do) + +## Issues + +1. Do a quick search on GitHub to check if the issue has already been reported. +2. [Open an issue](https://github.com/lupoDharkael/flameshot/issues/new) and describe the issue you are having - you could include: + - Screenshots + - Ways to reproduce the issue. + - Your Flameshot version. + - Your platform (e.g. Windows 10 or Ubuntu 15.04 x64) + +After reporting you should aim to answer questions or clarifications as this helps pinpoint the cause of the issue. + +### Donations + +I improve Flameshot in my free time because I want to create something good for everyone to use. +If you want you can donate some bucks [here](https://www.paypal.me/lupoDharkael). \ No newline at end of file