What are "Acceptance Criteria" and where should we capture them?
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by reviewing the existing contribution guidelines and the two comments on this issue. Compare the proposed checklist-in-the-first-comment workflow with other acceptance-criteria examples, then document the agreed definition, examples, and storage location once the discussion reaches a decision.
Written by the indexing model from the issue text.
Description
Each ("User") Story that we work on has a basic requirement which is captured in the story.
However in order to satisfy that requirement we need a precise "Acceptance Criteria".
What are good examples of Acceptance Criteria and where should we keep them?
My suggestion is that we keep the Acceptance Criteria as a checklist in the first Comment of the GitHub issue so that everyone is clear where to look for the criteria; the added advantage is that we get the "progression":
So everyone can see at a glance in the backlog (issue) "list" view how much is still required to complete the story.
Thoughts?
Suggestions welcome! 👍
- Dominant language
- No language data
- Stars
- 91
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dwyl/contributing
-
bug chore starter
Difficulty 1/5 Under an hour Newbie friendliness 38/100
dwyl/contributing#119 · 1 reaction ·
-
enhancement starter
Difficulty 1/5 1-3 hours Newbie friendliness 35/100
dwyl/contributing#118 · 1 reaction ·
-
discuss enhancement
Difficulty 4/5 3-5 days Newbie friendliness 25/100
dwyl/contributing#113 · 2 reactions ·
-
discuss enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
dwyl/contributing#112 · 1 reaction ·
-
Draft Pull Requests!Opendiscuss enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
dwyl/contributing#111 · 2 comments · 3 reactions ·
All issues in dwyl/contributing
Similar issues
-
[Sync EN] Fix session read handler docs: false reports a failure, not a missing session (#5902)Opensync-en
Difficulty 2/5 1-2 days Newbie friendliness 84/100
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
unixorn/awesome-zsh-plugins#2285 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
astrodbtoolkit/astrodb-bot#105 ·