Skip to content

Instantly share code, notes, and snippets.

@auremoser

auremoser/README.md

Created May 28, 2015 08:08
Show Gist options
  • Save auremoser/72803ba969d0e61ff070 to your computer and use it in GitHub Desktop.
Save auremoser/72803ba969d0e61ff070 to your computer and use it in GitHub Desktop.
Download ZIP
Github Issue Template
Raw
README.md

This template is my ideal format for issues submitted to a github repository.

Raw
issue_template.md

[provide general introduction to the issue logging and why it is relevant to this repository]

Context

[provide more detailed introduction to the issue itself and why it is relevant]

Process

[ordered list the process to finding and recreating the issue, example below]

  1. User goes to delete a dataset (to save space or whatever)
  2. User gets popup modal warning
  3. User deletes and it's lost forever

Expected result

[describe what you would expect to have resulted from this process]

Current result

[describe what you you currently experience from this process, and thereby explain the bug]

Possible Fix

[not obligatory, but suggest fixes or reasons for the bug]

  • Modal tells the user what dataset is being deleted, like “You are about to delete this dataset: car_crashes_2014.”
  • A temporary "Trashcan" where you can recover a just deleted dataset if you mess up (maybe it's only good for a few hours, and then it cleans the cache assuming you made the right decision).

name of issue screenshot

[if relevant, include a screenshot]

Examples

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