2020-11-29 13:01:13 +01:00
|
|
|
|
# Every Contribution Makes a Difference
|
2019-01-09 02:09:38 +01:00
|
|
|
|
|
2021-12-25 20:54:27 +01:00
|
|
|
|
Think of Open Source development as free training with a visible outcome. Exploring new
|
|
|
|
|
technologies is easier than in typical enterprise environments, where development efforts
|
|
|
|
|
are more focused on immediate results.
|
2019-01-09 02:09:38 +01:00
|
|
|
|
|
2021-12-25 20:54:27 +01:00
|
|
|
|
We welcome contributions of any kind, including bug reports, testing, writing documentation,
|
|
|
|
|
tutorials, blog posts, and pull requests.
|
2019-01-09 02:09:38 +01:00
|
|
|
|
|
2021-01-31 11:12:45 +01:00
|
|
|
|
## Questions? ##
|
2019-01-09 02:09:38 +01:00
|
|
|
|
|
2022-01-10 09:47:47 +01:00
|
|
|
|
Follow us on [Twitter](https://twitter.com/photoprism_app) or join our [Community Chat](https://gitter.im/browseyourlife/community)
|
|
|
|
|
to get regular updates, connect with other contributors, and discuss your ideas.
|
2020-01-15 14:45:49 +01:00
|
|
|
|
|
2022-01-10 09:47:47 +01:00
|
|
|
|
Our [Code of Conduct](CODE_OF_CONDUCT.md) explains the "dos and don’ts."
|
2019-01-09 02:09:38 +01:00
|
|
|
|
|
2022-01-10 09:47:47 +01:00
|
|
|
|
## Reporting Bugs ##
|
2019-01-09 02:09:38 +01:00
|
|
|
|
|
2022-01-10 14:00:49 +01:00
|
|
|
|
Before reporting a bug, please use our [Troubleshooting Checklists](https://docs.photoprism.app/getting-started/troubleshooting/)
|
|
|
|
|
to determine the cause of your problem. If you are unsure, need technical support, or have other questions:
|
2019-01-09 02:09:38 +01:00
|
|
|
|
|
2022-01-10 14:00:49 +01:00
|
|
|
|
- you are welcome to ask in our [Community Chat](https://gitter.im/browseyourlife/community)
|
|
|
|
|
- and post your question in [GitHub Discussions](https://github.com/photoprism/photoprism/discussions)
|
2019-01-09 02:09:38 +01:00
|
|
|
|
|
2022-01-10 14:00:49 +01:00
|
|
|
|
In addition, [sponsors](https://docs.photoprism.app/funding/) receive direct [technical support](https://photoprism.app/contact) via email.
|
|
|
|
|
|
|
|
|
|
When reporting a [clearly identified bug](https://github.com/photoprism/photoprism/issues), always include the
|
|
|
|
|
version you are using and information about your environment such as browser, operating system, installed memory,
|
|
|
|
|
and processor type (see [template](https://github.com/photoprism/photoprism/blob/develop/.github/ISSUE_TEMPLATE/bug_report.md)).
|
2019-12-30 20:10:45 +01:00
|
|
|
|
|
2021-01-31 11:12:45 +01:00
|
|
|
|
## Pull Requests ##
|
2020-11-29 13:01:13 +01:00
|
|
|
|
|
2022-01-10 09:47:47 +01:00
|
|
|
|
The [Developer Guide](https://docs.photoprism.app/developer-guide/) contains all information
|
2021-11-27 18:50:29 +01:00
|
|
|
|
necessary to get you started.
|
2020-11-29 13:01:13 +01:00
|
|
|
|
Issues labeled [help wanted](https://github.com/photoprism/photoprism/labels/help%20wanted) /
|
|
|
|
|
[easy](https://github.com/photoprism/photoprism/labels/easy) can be good (first) contributions.
|
2021-01-30 14:02:15 +01:00
|
|
|
|
|
2022-01-10 09:47:47 +01:00
|
|
|
|
Because we want to create the best possible product for our users,
|
|
|
|
|
we have a [set of guidelines](https://docs.photoprism.app/developer-guide/pull-requests)
|
2021-11-27 18:50:29 +01:00
|
|
|
|
to ensure that all source code submissions are acceptable.
|
2022-01-10 09:47:47 +01:00
|
|
|
|
They include step-by-step instructions for submitting new features,
|
2021-11-27 18:50:29 +01:00
|
|
|
|
bug fixes, and documentation improvements.
|
2021-01-30 14:02:15 +01:00
|
|
|
|
|
2022-01-10 09:47:47 +01:00
|
|
|
|
**Reviewing, testing and finally merging pull requests requires significant resources
|
2021-11-27 18:50:29 +01:00
|
|
|
|
on our side. If it's not just a small fix, it can take several months.**
|
2021-11-27 15:02:25 +01:00
|
|
|
|
|
2021-01-31 11:12:45 +01:00
|
|
|
|
## Can't code? ##
|
2021-01-30 14:02:15 +01:00
|
|
|
|
|
2022-01-10 09:47:47 +01:00
|
|
|
|
No worries, you can also contribute by...
|
2021-01-31 11:12:45 +01:00
|
|
|
|
|
2022-01-10 09:47:47 +01:00
|
|
|
|
* Doing [research](https://github.com/photoprism/photoprism/issues?q=is%3Aopen+is%3Aissue+label%3Aresearch) or improving our [docs](https://github.com/photoprism/photoprism/issues?q=is%3Aopen+is%3Aissue+label%3Adocs)
|
|
|
|
|
* Recommending PhotoPrism to your friends
|
|
|
|
|
* Voting for us on pages like:
|
2021-01-30 14:02:15 +01:00
|
|
|
|
* https://alternativeto.net/software/photoprism/about/
|
|
|
|
|
* https://www.saashub.com/google-photos-alternatives
|
2022-01-10 09:47:47 +01:00
|
|
|
|
* Publishing tutorials, blog posts, or podcasts
|
2021-01-30 14:02:15 +01:00
|
|
|
|
|
2022-01-10 09:47:47 +01:00
|
|
|
|
Thank you! <3
|
2021-01-30 14:02:15 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|