Skip to content

Instantly share code, notes, and snippets.

@RobertoMachorro

RobertoMachorro/Issue_Template.md

Created April 28, 2020 15:27
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save RobertoMachorro/dd5b6bddd034e4fd3e5fc533f4a67f97 to your computer and use it in GitHub Desktop.
Save RobertoMachorro/dd5b6bddd034e4fd3e5fc533f4a67f97 to your computer and use it in GitHub Desktop.
Download ZIP
A generic template for Issues
Raw
Issue_Template.md

Requirement Description/Specification

As a USER, I want FEATURE, so that PROBLEM RESOLVED.

Details go here about what the stakeholders are requesting, identifying the stakeholders is helpful.

Functional Description/Specification

Explain here how everything is expected to work from a users' perspective, edits can be kept for the record. Screenshots here are useful. Use sub-headings to split functionality into groups or addendums. Checklists with resolvable items are automatically tracked for progress.

Technical Description/Specification

Explain here how everything is expected to work from a developer or technical perspective, edits can be kept for the record. Screenshots here are useful. Use sub-headings to split functionality into groups or addendums. Files can be attached with specifications. Libraries and dependencies can be specified. Checklists with resolvable items are automatically tracked for progress.

Testing or Closure Comments

An optional retrospective can be added, including manuals or testing/deployment nots, edits can be kept for the record.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment