Skip to content

Commit

Permalink
docs(github): add issue and pull request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
zainfathoni committed Jun 12, 2022
1 parent 1fcfc62 commit 46f90f2
Show file tree
Hide file tree
Showing 4 changed files with 123 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Bug Report
about: Something's not working as expected.
title: ''
labels: bug
---

## Description

<!-- Describe the issue that you're seeing. -->

## Expected Behaviour

<!-- What should've happened? -->

## Additional Information

<!-- (Optional) Any additional info that you think might come in handy for debugging. -->
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Epic
about: A master issue thread which contains other smaller issues.
title: ''
labels: epic
assignees: zainfathoni
---

## Overview

<!-- Describe what this epic is all about and how the project could benefit from it. -->

## Definition of Done

<!-- List all the requirements for each issue under this epic to be considered `Done` -->

1. Requirement 1
2. Requirement 2
3. Requirement 3

## Current Tasks

<!-- List all the tasks here in markdown checkboxes. We can later spin off these into individual issue threads through the GitHub UI. -->

- [ ] (task 1)
- [ ] (task 2)
- [ ] (task 3)
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
name: Feature Request
about: Propose feature additions to the project.
title: ''
labels: enhancement
---

## Description

<!-- Describe the proposed feature and how the project could benefit from it. -->

## Narrative

<!-- A short introductory section with the following structure: -->

- **As a** <!-- the person or role who will benefit from the feature -->
- **I want** <!-- the feature -->
- **so that** <!-- the benefit or value of the feature -->

## Acceptance Criteria

<!-- A description of each specific scenario of the narrative with the following structure: -->

### Scenario 1: <!-- Scenario title -->

- **Given** <!-- the initial context at the beginning of the scenario -->
- **and** <!-- if more than one clause -->
- **when** <!-- the event that triggers the scenario -->
- **then** <!-- the expected outcome -->
- **and** <!-- if more than one clause -->

## Implementation Model

<!-- (Optional) If available, outline the possible steps to take (e.g. lines of code to change, architectural details, etc.) to implement the feature. -->

### Image previews

<details>
<summary>Component name</summary>

#### Desktop view

#### Mobile view

</details>

### Code snippets

<details>
<summary>Component name</summary>

```jsx

```

</details>

## Tasks

<!-- (Optional) List any available tasks for this issue with checkbox lists. -->

- [ ] ...
- [ ] ...
- [ ] ...
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Closes <!-- mention the issue that you're trying to close with this PR -->

## Description

<!-- Describe your implementation plan and approach -->

## Current Tasks

<!-- (Optional) List the tasks you're planning to do in this PR.
This section is to indicate how much you have been progressing before this PR is ready for review -->

- [ ] (task 1)
- [ ] (task 2)
- [ ] (task 3)

0 comments on commit 46f90f2

Please sign in to comment.