flameshot/CONTRIBUTING.md

Contributing

Contributions are welcome! Here's how you can help:

• Translating
• Contributing code
• Reporting issues
• Donating

Translations

Check this nice official documentation from Qt docs as it explains how to translate for a project written with Qt: https://doc.qt.io/qt-5/linguist-translators.html

Status:

Language	Code	Status	Contributors
Spanish	es	🔖v0.1.0	lupoDharkael
Catalan	ca	🔖v0.5.0	joamuran
Russian	ru	🔖v0.5.1	Shatur95
Chinese (Simplified)	zh_CN	🔖v0.5.1	copie, hosiet
Chinese (Traditional)	zh_TW	🔖v0.5.1	PeterDaveHello
Turkish	tr	🔖v0.5.1	oltulu
Georgian	ge	🔖v0.5.1	giogziro95
French	fr	🔖v0.5.1	ld892012
Polish	pl	🔖v0.5.1	napcok

Code

1. Fork the repository and clone 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 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.