6 KiB
Every Contribution Makes a Difference
We welcome contributions of any kind, including blog posts, tutorials, testing, writing documentation, and pull requests. Our Developer Guide contains all the information necessary for you to get started.
Join the Community
Follow us on Twitter and join the Community Chat to get regular updates, connect with other contributors, and discuss your ideas. Our Code of Conduct explains the "dos and don’ts" when interacting with other community members.
Feel free to contact us with anything that is on your mind. We appreciate your feedback! Due to the high volume of emails we receive, our team may be unable to get back to you immediately. We do our best to respond within five business days or less.
Not a Developer? No Problem
You can also contribute by...
- answering questions in the Community Chat, on Reddit and in GitHub Discussions
- helping us translate the Web UI
- conducting research and improving the documentation
- publishing tutorials, blog posts, and podcasts
- voting for us on pages like:
- recommending PhotoPrism to your friends
Creating Bug Reports
Before reporting a bug, please use our Troubleshooting Checklists to determine the cause of your problem. If you have a general question, need help, or an issue has not (yet) been clearly identified:
- You are welcome to ask in our Community Chat
- or post your question in GitHub Discussions
GitHub Issues
We kindly ask you not to report bugs via GitHub Issues unless you are certain to have found a fully reproducible and previously unreported issue that must be fixed directly in our source code. Thank you for your careful consideration!
- When reporting a problem, always include the software versions you are using and other information about your environment such as browser, browser plugins, operating system, storage type, memory size, and processor
- Note that all issue subscribers receive an email notification from GitHub for each new comment, so these should only be used for sharing important information and not for personal discussions/questions
- Contact us or a community member if you need help, it could be a local configuration problem, or a misunderstanding in how the software works
- This gives our team the opportunity to improve the docs and provide best-in-class support to you, instead of handling unclear/duplicate bug reports or triggering a flood of notifications by responding to comments
Submitting Pull Requests
Because we want to create the best possible product for our users, we have a set of criteria to ensure that all submissions are acceptable.
Follow our step-by-step guide to learn how to submit new features, bug fixes, and documentation enhancements. Issues labeled help wanted / easy can be good (first) contributions.
Reviewing, testing and finally merging pull requests requires significant resources on our side. If it's not just a small fix, it can take several months.
Contributor License Agreement (CLA)
After you submit your first pull request, you will be asked to accept our Contributor License Agreement (CLA). Visit photoprism.app/cla to learn more.
Privacy Notice
We operate a number of web services that help us develop and maintain our software in collaboration with the open source community, such as Weblate hosted at translate.photoprism.app to keep translations up to date.
Because many of these apps and tools were originally developed for internal use without a high level of privacy in mind, we ask that you do not enter personal information such as your real name or personal email address if you want it to remain private.
Be aware that such information may unexpectedly show up in logs, source code, translation files, commit messages, and pull request comments.
PhotoPrism® is a registered trademark. By using the software and services we provide, you agree to our Terms of Service, Privacy Policy, and Code of Conduct. Docs are available under the CC BY-NC-SA 4.0 License; additional terms may apply.