Skip to content

GitHub Issues

We use GitHub issues for managing bugs, ideas, and todos. Issues labeled help wanted / easy can be good (first) contributions.

Don't hesitate to contact us if you want to work on something specific or need help with a pull request. We kindly ask you not to report bugs via GitHub Issues unless you are certain to have found a new issue that must be fixed directly in the app.

How to Write User Stories

Start describing new ideas and tasks 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.

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

Effectiveness > Efficiency

Optimize for effectiveness before efficiency.

It is fundamentally the confusion between effectiveness and efficiency that stands between doing the right things and doing things right. There is surely nothing quite so useless as doing with great efficiency what should not be done at all. — Peter Drucker

Feature Factory