Skip to content

Commit

Permalink
Docs: Update CONTRIBUTING.md and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lastzero committed Jan 17, 2022
1 parent 198047d commit aed3f0f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,16 @@ to determine the cause of your problem. If you have a general question, need hel

### GitHub Issues ###

Don't report a bug unless you are sure you found a new problem that must be fixed directly in the app:
**Never report a bug unless you are sure you found a new problem that must be fixed directly in [our source code](https://github.com/photoprism/photoprism):**

- 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

## Submitting Pull Requests ##

[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)
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 source code submissions are acceptable.

They include step-by-step instructions for submitting new features,
bug fixes, and documentation improvements.
Issues labeled [help wanted](https://github.com/photoprism/photoprism/labels/help%20wanted) /
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ An important part of our journey is to explore new ways in product development a

## Every Contribution Makes a Difference ##

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.
We welcome [contributions](CONTRIBUTING.md) 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.

----

Expand Down

0 comments on commit aed3f0f

Please sign in to comment.