Skip to content

Commit

Permalink
feat: issue templates (#87)
Browse files Browse the repository at this point in the history
Co-authored-by: steven <[email protected]>
  • Loading branch information
stevennevins and steven authored Dec 11, 2023
1 parent 2f64af7 commit 5d5f574
Show file tree
Hide file tree
Showing 4 changed files with 114 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, could you add screenshots to help explain your problem?

**Environment**
Enter important environment info needed to reproduce the bug.
- [e.g. chrome, safari]
- [e.g. version]

**Don't Forget To**
* Assign this to a project (our default is [eigenlayer](https://github.com/orgs/Layr-Labs/projects/3/))
* Add priority + size estimate
* Set status to New
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Design
about: Design
title: "Design: Title"
labels: design
---

## Description

Add a summary and description. What are we trying to do and why?

### Action Items

- [ ] Come up with scheme for...
- [ ] Spec it in a HackMD or Google Doc that is linked here
- [ ] Get @ to review design
- [ ] Discuss design and tradeoffs with @
- [ ] Finalize the doc, and come to consensus
- [ ] Create ticket for implementation and link the doc to it

### Blocking Issues

Is anything blocking for this? (Does this depend on other unfinished designs or pending changes?)
Please link blocking issues here. If something is blocking and doesn't have an issue yet, create it!

### Don't Forget To

- Assign this to a project (our default is [eigenlayer](https://github.com/orgs/Layr-Labs/projects/3/))
- Add priority + size estimate
- Set status to New
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**User story**
User stories are often expressed in a simple sentence, structured as follows: 'As a PERSONA, I want to GOAL_DESCRIPTION, so that CUSTOMER_VALUE_DESCRIPTION.' Alternatively for

**Actions**
- [ ] An action item list describing the work to be done
- [ ] Link to all of the related tasks needed to complete the feature. See the [tasks](https://github.com/Layr-Labs/docs/blob/949bd6b4ddd0ef08880c6775c2d9a6222e2e7eb3/.github/ISSUE_TEMPLATE/task.md) template.
- [ ] Include everything in the definition of done e.g. unit tests and documentation

**Acceptance criteria**
Acceptance criteria are the requirements that need to be met in order to mark a user story as complete. For example, if your user story is, "As a New Relic customer, I want to know how to interpret AI anomalies in order to monitor my site and protect myself against incidents," then the acceptance criteria would be: "A complete and published doc describing AI anomalies," and all related quality checks.

**Don't Forget To**
* Assign this to a project (our default is [eigenlayer](https://github.com/orgs/Layr-Labs/projects/3/))
* Add priority + size estimate
* Set status to New
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Test
about: Indentified areas that require additional testing
title: ''
labels: ''
assignees: ''

---

## Description
Add a summary and description. What are we trying to do and why?

### Action Items
- [ ] Discuss scoping for tests with the team
- [ ] List possible test cases in this issue
- [ ] Get @ to review design
- [ ] Implement tests

### Blocking Issues
Is anything blocking for this? (Does this depend on other unfinished designs or pending changes?)
Please link blocking issues here. If something is blocking and doesn't have an issue yet, create it!

### Don't Forget To
* Assign this to a project (our default is [eigenlayer](https://github.com/orgs/Layr-Labs/projects/3/))
* Add priority + size estimate
* Set status to New

0 comments on commit 5d5f574

Please sign in to comment.