photoprism/CONTRIBUTING.md

75 lines
3.4 KiB
Markdown
Raw Normal View History

# Every Contribution Makes a Difference
2019-01-09 02:09:38 +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
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
## Code of Conduct ##
Our [code of conduct](CODE_OF_CONDUCT.md) explains the "dos and don'ts."
2021-01-31 11:12:45 +01:00
## Questions? ##
2019-01-09 02:09:38 +01:00
2021-05-15 10:53:29 +02:00
Follow us on [Twitter](https://twitter.com/photoprism_app) to receive regular project updates,
get in contact with other contributors and discuss your ideas.
2019-01-09 02:09:38 +01:00
Of all the tools we tested, it works best to get and give continuous feedback.
Especially polls are amazing for product development.
## Roadmap ##
2019-01-09 02:09:38 +01:00
Our vision is to provide the most user-friendly solution for browsing, organizing, and sharing your photo collection.
The [roadmap](https://github.com/photoprism/photoprism/projects/5) shows what tasks are in progress,
what needs testing, and which feature requests are going to be implemented next.
2019-01-09 02:09:38 +01:00
Please give ideas you like a thumbs-up 👍 , so that we know what is most popular.
Ideas backed by one or more eligible [sponsors](SPONSORS.md) will be prioritized as well.
2019-01-09 02:09:38 +01:00
You are welcome to add specific feature requests directly to our [GitHub issue tracker](https://github.com/photoprism/photoprism/issues)
if no similar [idea](https://github.com/photoprism/photoprism/labels/idea)
or [todo](https://github.com/photoprism/photoprism/labels/todo) already exists.
Please don't use the issue tracker to ask general questions.
## Reporting Bugs ##
2019-01-09 02:09:38 +01:00
Please use the [GitHub issue tracker](https://github.com/photoprism/photoprism/issues) to report clearly identified bugs and impediments to us.
If you're not sure, start by asking in our [community chat](https://gitter.im/browseyourlife/community) or [contact us via email](mailto:help@photoprism.app).
When reporting an issue, please provide the version in use and information about your environment like browser, operating system, installed memory, and processor type.
2021-01-31 11:12:45 +01:00
## Pull Requests ##
2021-12-12 20:14:07 +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.
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
2021-11-27 18:50:29 +01:00
Because we want to create the best possible product for our users,
2021-12-12 20:14:07 +01:00
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.
They include step-by-step instructions for submitting new features,
bug fixes, and documentation improvements.
2021-01-30 14:02:15 +01:00
2021-11-27 18:50:29 +01:00
**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.**
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
2021-01-31 11:12:45 +01:00
No worries, you may also contribute by...
2021-01-31 11:18:00 +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)
2021-01-31 11:12:45 +01:00
* recommending PhotoPrism to your friends
2021-01-30 14:02:15 +01:00
* voting for us on pages like:
* https://alternativeto.net/software/photoprism/about/
* https://www.saashub.com/google-photos-alternatives
2021-01-31 11:12:45 +01:00
* publishing tutorials, blog posts, or podcasts
2021-01-30 14:02:15 +01:00
2021-01-31 11:13:23 +01:00
Thank you very much! <3
2021-01-30 14:02:15 +01:00