luisgulo/photoprism
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs: Update README.md and CONTRIBUTING.md

Browse source
This commit is contained in:
Michael Mayer 2020-11-29 13:01:13 +01:00
parent 1938313e67
commit ebf908af14
2 changed files with 30 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
CONTRIBUTING.md
View file

@ -1,4 +1,4 @@
# Every contribution makes a difference
# Every Contribution Makes a Difference
Think of open-source development as free training with a visible outcome.
Exploring new technologies is easier than in commercial environments,
@ -10,33 +10,40 @@ We welcome contributions of any kind including pull requests, ideas, bug reports
testing, writing documentation, tutorials and blog posts. If you help with development,
you have the opportunity to learn Docker, Go, TensorFlow and much more.
## Questions? ##
## Questions?
Follow us on [Twitter][twitter] and join our [developers mailing list](https://groups.google.com/a/photoprism.org/forum/#!forum/developers)
to receive regular project updates, get in contact with other contributors and discuss your ideas. Don't be afraid to ask stupid questions.
Follow us on [Twitter](https://twitter.com/browseyourlife) to receive regular project updates,
get in contact with other contributors and discuss your ideas. Don't be afraid to ask stupid questions.
Of all the tools we tested, Twitter works best to get and give continuous feedback. Especially polls are amazing for product development.
Of all the tools we tested, it works best to get and give continuous feedback.
Especially polls are amazing for product development.
## Pull requests ##
## Roadmap ##
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.
Our [Developer Guide](https://docs.photoprism.org/developer-guide/) contains all information necessary to get you started.
Our [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.
Our [step-by-step guide](https://github.com/photoprism/photoprism/wiki/Pull-Requests) explains how to submit new features, bugfixes and documentation.
Just go for it and you will eventually find your way in the world of open source.
## Feature requests ##
Please give ideas you like a thumbs-up 👍 , so that we know what is most popular.
Ideas backed by one or more [sponsors](SPONSORS.md) will be prioritized as well.
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 ##
Our long-term vision is to provide the most user-friendly solution for browsing,
organizing and sharing your personal photo collection.
## Reporting Bugs ##
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 [help forum](https://groups.google.com/a/photoprism.org/forum/#!forum/help) or [contact us via email](mailto:help@photoprism.org).
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.
[twitter]: https://twitter.com/browseyourlife
## Pull Requests
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.
The Developer Guide contains all information necessary to get you started.
Our [step-by-step guide](https://docs.photoprism.org/developer-guide/pull-requests/) explains how to submit new features, bugfixes and documentation.

17
README.md
View file

@ -34,6 +34,8 @@ Say goodbye to solutions that force you to upload your visual memories to the cl
## Getting Started ##
You're welcome to play with our public demo at [demo.photoprism.org](https://demo.photoprism.org/).
Step-by-step installation instructions for our self-hosted [community edition](https://photoprism.app/get) can be found
on [docs.photoprism.org](https://docs.photoprism.org/getting-started/) -
all you need is a Web browser and Docker to run the server. It is available for Mac, Linux and Windows.
@ -42,15 +44,7 @@ We do our best to provide a complete, stable version very soon. Check the
[roadmap](https://github.com/photoprism/photoprism/projects/5) for open issues.
Leave your email to get a [release notification](https://goo.gl/forms/KBPVGl9PCsOKrAv33).
## Try PhotoPrism ##
You're welcome to play with our public demo at [demo.photoprism.org](https://demo.photoprism.org/).
## Our Vision ##
We strive to provide the most user-friendly solution for browsing, organizing and sharing your personal photo collection.
## Feature Requests ##
## Roadmap ##
Our [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.
@ -58,6 +52,9 @@ what needs testing, and which feature requests are going to be implemented next.
Please give ideas you like a thumbs-up 👍 , so that we know what is most popular.
Ideas backed by one or more [sponsors](SPONSORS.md) will be prioritized as well.
Our long-term vision is to provide the most user-friendly solution for browsing,
organizing and sharing your personal photo collection.
## Contributions ##
We welcome contributions of any kind. If you have a bug or an idea, read our
@ -107,7 +104,7 @@ Your continuous support helps...
Also, please [leave a star](https://github.com/photoprism/photoprism/stargazers) on GitHub if you like this project.
It provides additional motivation to keep going.
Ideas backed by one or more eligible sponsors are marked with a golden [sponsor](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Asponsor) label.
Ideas backed by one or more eligible [sponsors](SPONSORS.md) are marked with a golden [sponsor](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Asponsor) label.
Let us know if we mistakenly label an idea as [unfunded](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Aunfunded).
Thank you very much! <3