Skip to content

Latest commit

History

History
42 lines (25 loc) 路 2.41 KB

CONTRIBUTING.md

File metadata and controls

42 lines (25 loc) 路 2.41 KB

Contribute

Introduction

First, thank you for considering contributing to ImageGlass! It's people like you that make the open source community such a great community! 馃槉

We welcome any type of contribution, not only code. You can help with

  • QA: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
  • Marketing: writing blog posts, howto's, printing stickers, ...
  • Community: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
  • Code: take a look at the open issues. Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
  • Money: we welcome financial contributions in full transparency on our Github Sponsor or Paypal.
  • Translation: because we want our software to be accessible by anyone, even if they don't speak English. We have a Crowdin page to make the translation of ImageGlass easier.

Submitting code

Any code change should be submitted as a pull request, based on develop branch. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.

Code review process

The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?

Questions

If you have any questions, create an issue (protip: do a quick search first to see if someone else didn't ask the same question before!). You can also reach us at phap@imageglass.org.

Credits

Contributors

Thank you to all the people who have already contributed to imageglass!

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by [become a Sponsor]