photoprism/CONTRIBUTING.md

64 lines
4.8 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. Our [Developer Guide](https://docs.photoprism.app/developer-guide/) contains all the information necessary for you to get started.
## Join the Community ##
2019-01-09 02:09:38 +01:00
Follow us on [Twitter](https://twitter.com/photoprism_app) and join the [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
An important part of our journey is to explore new ways in product development and build better software through consistent use of community feedback. Feel free to [share your thoughts](https://photoprism.app/contact) with us at any time.
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)
2022-01-16 17:39:11 +01:00
- or post your question in [GitHub Discussions](https://github.com/photoprism/photoprism/discussions)
2019-01-09 02:09:38 +01:00
### GitHub Issues ###
**Never report a bug unless you are certain to have found a new issue that must be fixed directly in [our source code](https://github.com/photoprism/photoprism):**
- [Contact us](https://photoprism.app/contact) or [a community member](https://github.com/photoprism/photoprism/discussions) 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 documentation](https://docs.photoprism.app/getting-started/troubleshooting/) and provide best-in-class support to you, instead of handling unclear 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 ##
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) to ensure that all submissions are acceptable.
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-18 14:09:59 +01:00
### Contributor License Agreement ###
After submitting your first pull request, you will automatically be asked to accept our [Contributor License Agreement (CLA)](https://cla-assistant.io/photoprism/photoprism):
- This gives us the ability to [(re-)license all code and docs](https://en.wikipedia.org/wiki/Software_relicensing) at any time, almost as if every line was written by us (you retain the rights to your own work, which may be different for other CLAs)
- Otherwise, we cannot accept pull requests, as this would mean that we are not able to change the license at a later time, even though most of the code was developed by us
2022-01-18 14:13:31 +01:00
- This may be necessary, for example, if the license is incompatible with a larger combined work, we want to remove some restrictions on the AGPL/Creative Commons license, or it turns out that someone is abusing the existing license in a way we don't yet know about
2022-01-18 14:09:59 +01:00
- The lack of a formal contract would also lead to legal uncertainty, as some contributors could later claim that they did not intend to license their code in any way and that it was stolen
2022-01-17 13:22:03 +01:00
## Not a Developer? No Problem ##
2021-01-31 11:12:45 +01:00
You can also contribute by...
* [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
* recommending PhotoPrism to your friends
2021-01-30 14:02:15 +01:00
----
2021-01-30 14:02:15 +01:00
*PhotoPrism® is a registered trademark. Our [Trademark and Brand Guidelines](https://photoprism.app/trademark), which may be updated from time to time, describe how our Brand Assets may be used. It is important to us that any permitted use of our Brand Assets is fair and meets the highest standards.*