Skip to content

Instantly share code, notes, and snippets.

@mcous

mcous/ISSUE_TEMPLATE.md

Created September 15, 2017 18:00
Show Gist options
  • Save mcous/7b9b2ebe5488be544f8477b0d07f1c0f to your computer and use it in GitHub Desktop.
Save mcous/7b9b2ebe5488be544f8477b0d07f1c0f to your computer and use it in GitHub Desktop.
Download ZIP
Simple issue and pull-request templates
Raw
ISSUE_TEMPLATE.md

checklist

This issue is for:

  • Bug, feature request, or other (if other, please describe below)?
  • API, App, both?
  • Version?
  • OS and OS version?

expected or desired behavior

Describe how you expect the software to act or how you think the software should act.

actual behavior

Describe how the software actually behaves.

steps to reproduce problem

  1. Steal underpants
  2. ???
  3. Profit!
Raw
PULL_REQUEST_TEMPLATE.md

overview

Write a high level description of the pull request.

This PR includes:

  • Chore work
  • Bug fixes
  • Backwards-compatible feature additions
  • Breaking changes
  • Documentation updates
  • Test updates

Note: If you did not check "Documentation updates" and/or "Test updates" then your PR may not be ready!

changelog

Write descriptions for your changes. If a change is related to a GitHub issue, please tag the issue in the description.

  • (Chore) Change description
  • (Fix) Change description
  • (Feature) Change description
  • (Refactor) Change description
  • (Docs) Change description
  • (Tests) Change description

Note: If your PR incorporates many changes, or many different types of changes, please consider splitting it up into smaller PRs.

review requests

Describe any specific requests for your reviewers here. Tag any people or groups as necessary.

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