commonality / generator-community

䷤ Generate README, CODE_OF_CONDUCT, CONTRIBUTING, LICENSE, ISSUE_TEMPLATE, and PULL_REQUEST_TEMPLATE repository docs to encourage consumption and invite contributions.
MIT License
9 stars 7 forks source link

feat(github-templates): generate a PULL_REQUEST_TEMPLATE.md and ISSUE_TEMPLATE.md #11

Open gregswindle opened 7 years ago

gregswindle commented 7 years ago

1. Issue type

⌦ Type the letter "x" in the "checkbox" the best describe this issue.

2. User story summary

⌦ Describe what you want to accomplish, in what role/capacity, and why it's important to you.

EXAMPLE: As a Applicant, I want to submit my resume In order to be considered for a job opening.

As a {role}, I must/need/want/should {do something} In order to {achieve value}.

3. Acceptance criteria

⌦ Replace the examples below with your own imperative, "true/false" statements for the behavior you expect to see, or the behavior that would be true if there were no errors (for defects).

🐞 4. Steps to reproduce (for defects only)

⌦ Provide a link to a live example, or ⌦ Replace the examples below with an unambiguous sequence of instructions that end with proof of the defect. ⌦ Include source code and log files, if relevant and available.

  1. Enter the words "...." into the "Search" text field.
  2. Select the Search button.
  3. Next...
  4. Then...
  5. Finally...
  6. X does not work as expected.

🐞 5. Your environment (for defects only)

⌦ Include as many relevant details about the environment in which the defect occured.