Skip to content

Instantly share code, notes, and snippets.

@taotiwordpress
Last active October 4, 2021 13:45
Show Gist options
  • Save taotiwordpress/7a07b6d745f6a211a2ba973b1197d030 to your computer and use it in GitHub Desktop.
Save taotiwordpress/7a07b6d745f6a211a2ba973b1197d030 to your computer and use it in GitHub Desktop.
Task Creation Templates #templates #tasking #teams #markdown #bugs #tasks #enhancements #epics

Type of Issue: Bug

Expected Behavior and Background

Current Behavior

Possible Solution

Steps to Reproduce

Context

  • Browser:
  • Device/screen width:
  • Operating System:

Screenshot

Type of Issue: ????

Goals

Expected Behavior and Background

Current Behavior

Possible Solution

Steps to Reproduce (for existing functionality)

Context

  • Browser:
  • Device/screen width:
  • Operating System:

Screenshot

Issue Templates

  • version: 1.0.0-alpha

Depending on the scenario, there are a number of 'templates' that could make work a little easier if previously templated.

Creating tasks, creating large feature requests, commenting on changes to insurance updates, and so on.

The linked / associated gists provide an initial draft of example templates, which can hopefully be built upon.

  • enhancement-request.md
  • short-task.md
  • bug-report.md
  • pull-request.md

Future Potential Integration Usage

When/If we start managing tasks via integration with TeamWork + GitHub (if possible), these templates can be dropped in a .github folder to auto-prompt pre-populated issues/pull-requests.

That said, each file would need to be modified with GitHub's expected "header" structured data.

Example GitHub Expected Structured Data

---
name: Pull Request Template
about: Create a Pull Request
title: ''
labels: ''
assignees: ''
---

Motivation/Purpose of Changes

Proposed Resolution/Implementation

Screenshot(s)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • Code follows the coding style of this project.
  • Change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Testing Steps

  1. git fetch && git checkout this branch.
  2. lando start
  3. List example tests

Potential Reviewers

Type of Issue: Task

Outcome

Expected Behavior and Background

Current Behavior

Possible Solution

Steps to Reproduce (for existing functionality)

Context

  • Browser:
  • Device/screen width:
  • Operating System:

Screenshot

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