photoprism/CONTRIBUTING.md

53 lines
3.3 KiB
Markdown
Raw Normal View History

# Every Contribution Makes a Difference
2019-01-09 02:09:38 +01:00
We welcome contributions of any kind, including blog posts, tutorials, testing, writing documentation, and pull requests.
2022-01-13 20:11:13 +01:00
[The Developer Guide contains all the information necessary for you to get started.](https://docs.photoprism.app/developer-guide/)
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
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.
Our [Code of Conduct](CODE_OF_CONDUCT.md) explains the "dos and donts."
2019-01-09 02:09:38 +01:00
2022-01-13 19:38:54 +01:00
## Creating Bug Reports ##
2019-01-09 02:09:38 +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 have a general question, need help, or an issue has not
(yet) been clearly identified:
2019-01-09 02:09:38 +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
### GitHub Issues ###
Don't report a bug unless you are sure you found a new problem that must be fixed directly in the app:
- Ask for [technical support](https://photoprism.app/contact) if you need help, it could be a local configuration issue, or a misunderstanding in how the software works
- This gives our team the opportunity to [improve the documentation](https://docs.photoprism.app/getting-started/troubleshooting/) and provide best-in-class support to you, instead of handling incomplete and/or duplicate bug reports
- When reporting a problem, always include the software versions you are using and other information about your environment such as [browser, browser plugins](https://docs.photoprism.app/getting-started/troubleshooting/browsers/), operating system, storage type, memory size, and processor
2022-01-13 19:38:54 +01:00
## Submitting Pull Requests ##
2022-01-13 20:11:13 +01:00
[Because we want to create the best possible product for our users, we have a set of guidelines to ensure that all source code submissions are acceptable.](https://docs.photoprism.app/developer-guide/pull-requests)
They include step-by-step instructions for submitting new features,
2021-11-27 18:50:29 +01:00
bug fixes, and documentation improvements.
2022-01-13 20:11: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
**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
2022-01-13 20:11:13 +01:00
## You can also contribute by... ##
2021-01-31 11:12:45 +01:00
2022-01-13 20:15:47 +01:00
* [Conducting research](https://github.com/photoprism/photoprism/issues?q=is%3Aopen+is%3Aissue+label%3Aresearch) and [improving the documentation](https://github.com/photoprism/photoprism/issues?q=is%3Aopen+is%3Aissue+label%3Adocs)
* Publishing tutorials, blog posts, and podcasts
* 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-13 20:15:47 +01:00
* Recommending PhotoPrism to your friends
2021-01-30 14:02:15 +01:00
2022-01-13 19:38:54 +01:00
## We Love Feedback ##
2021-01-30 14:02:15 +01:00
2022-01-13 19:38:54 +01:00
An important part of our journey is to explore new ways in product development and build better software through simplicity
and consistent use of community feedback. You are always [welcome to share your thoughts](https://photoprism.app/contact) with us.