diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..073932a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,36 @@ +--- +name: Bug report +about: Create a report to help us improve +--- + +## Description + +A small description of the bug, if possible provide a set of bullet points to be more precise. + +## Expected vs. Observed + +| - | - | +| --- | --- | +| **Expected** | The expected state at the end of the repro steps. | +| **Observed** | The observed state at the end of the repro steps. | + +## Repro Steps + +1. The first step +2. The second step +3. ... + +## Environment + +| Key | Value | +| --- | --- | +| **Device** | | +| **Operating System** | | +| **Browser** | | +| **Instance (URL)** | | + +## Screens + +A GIF showing how to reproduce the bug and/or a stacktrace, use http://recordit.co/. + +Try to embed the gif using `![URL](URL)` that way it's going to be embedded in an inline manner allowing immediate evaluation. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ac2e8b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md new file mode 100644 index 0000000..49a1c60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/user_story.md @@ -0,0 +1,37 @@ +--- +name: User story +about: New piece of functionality +--- + +## Rationale + +Why are we implementing this feature and what are the key concepts someone must understand to make sense of it. +It's critical that after reading this section the reader understands *why this feature is relevant for business*. + +## Description + +What the feature actually is, describes in detail the new functionality. Explaining how it should work from a stakeholder point of view. + +## Implementation + +How is it being implemented, both in terms of UI/UX design and software development. + +### UI/UX design + +Provide a brief description about the layout expected for this feature and that it's supposed to work. +If possible provide some visual information (eg: mockup using [Balsamiq Wireframes](https://balsamiq.com/wireframes/)). + +### Software development + +Give references and ideas on how this functionality may be implemented and the code areas that are going to be affected by these changes. + +## Reference + +Links that might be required to complement some of the information above, which might include documentation or other user stories. + +## Estimation + +| Discipline | Estimation | +| --- | --- | +| **UI/UX Design** | X days | +| **Software Development** | X days | diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..bf54401 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,6 @@ +| - | - | +| --- | --- | +| Issue | https://github.com/ripe-tech/ripe-api/issues/XXX | +| Dependencies | | +| Decisions | | +| Animated GIF | |