photoprism/CONTRIBUTING.md
2019-01-09 06:54:02 +01:00

2.9 KiB

Every contribution makes a difference

Think of open-source development as free training with a visible outcome. Exploring new technologies is easier than in commercial environments, where development effort is more focused on immediate results.

We welcome contributions of any kind including pull requests, ideas, bug reports, testing, writing documentation, tutorials and blog posts. If you help with development, you have the opportunity to learn Docker, Go, TensorFlow and much more.

Questions?

Join our developers mailing list to receive regular project updates, get in contact with other contributors and discuss your ideas. Don't be afraid to ask stupid questions.

Pull requests

Issues labeled help wanted / easy can be good (first) contributions. Our Developer Guide contains all information necessary to get you started.

Our step-by-step guide explains how to submit new features, bugfixes and documentation.

Funded issues

You'll get a small reward for working on funded issues, see issuehunt.io for details. Note that issue descriptions may be outdated on their site. Rewards are paid out when all acceptance criteria prioritized as MUST are met and your pull request was successfully merged.

Feature requests

You are welcome to add specific feature requests directly to our GitHub issue tracker if no similar idea or todo already exists. Please don't use the issue tracker to ask general questions.

We also maintain a couple of pages in our Developer Guide for collecting interesting ideas and feedback, e.g. Related, Love, Concerns and Research.

Reporting bugs

Please use the GitHub issue tracker to report clearly identified bugs and impediments to us. If you're not sure, start by asking in our help forum or contact us via email. When reporting an issue, please provide the version in use and information about your environment like browser, operating system, installed memory, and processor type.