GitHub Issues¶
We use GitHub issues for managing bugs, ideas, and enhancements. Issues labeled help wanted / easy can be good (first) contributions. You are welcome to email us if you want to work on something specific, need help with a pull request, or have something on your mind that you don't want to discuss publicly.
When browsing issues, please note that our team and all issue subscribers receive an email notification from GitHub whenever a new comment is added, so these should only be used for sharing important information and not for discussions, questions, or expressing personal opinions.
Writing User Stories¶
Start describing new ideas and enhancements with a user story similar to this one:
As a [type of person] I'd like to be able to [do something] so that I can [get some result].
This makes it easier for everyone to understand who wants what and why.
Reading between the lines consumes a lot of time that can be used more effectively. Vague requirements become even more expensive when the wrong things are implemented, or they don't provide value in the way they were implemented.
Creating Bug Reports¶
In order for us to investigate new bug reports, they must include a complete list of steps to reproduce the problem, the software versions used and information about the environment in which the problem occurred, such as browser type, browser version, browser plug-ins, operating system, storage type, processor type, and memory size:
https://www.photoprism.app/kb/reporting-bugs
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 the app. Before reporting a bug, first use our Troubleshooting Checklists to determine the cause of your problem. Contact us or a community member if you need help, it could be a configuration problem, or a misunderstanding in how the software works.
This gives us the opportunity to improve our documentation and provide best-in-class support instead of dealing with unclear/duplicate bug reports or triggering a flood of notifications by replying to comments. Thank you very much!
Acceptance Criteria¶
Issues should include a list of Acceptance Criteria that clearly state what is expected. We recommend using MAY, SHOULD, and MUST as keywords to indicate priorities.
Clickable checkboxes for each item can be created via GitHub Markdown:
Acceptance Criteria:
- [ ] "Log In" button MUST be visible on /login page
- [ ] "Log In" button MAY be disabled if password field is empty
- [ ] Page SHOULD use existing Vuetify components
- [ ] Login MUST work in latest Firefox, Safari and Chrome