Skip to content

Commit

Permalink
docs: add issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
miquelbeltran committed Nov 26, 2024
1 parent 7dc579f commit 2c9f9df
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Bug report
about: Bug report
title: "<Area of the SDK>: <Short Description of issue>"
labels: needs triage
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.

Links to related tickets or other context are welcome here.

**Screenshots**

If applicable, add screenshots to help explain your problem.

**Environment (please complete the following information):**

- OS: [e.g. Linux/Windows/macOS etc]
- SDK version: [e.g. 1.2.3]
- Dotnet versions: [e.g. 8.0.7]

**Logs**

If applicable, include relevant logs or error messages here (please use code blocks to format properly).

**Possible Solution**

If you have suggestions for how the issue might be resolved or investigated, please describe them here.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Feature request
about: A new feature for this SDK
title: "<Area of the SDK>: <Short Description of new feature>"
labels: needs triage
assignees: ''

---

**Please describe your new feature request**

A clear and concise description of what the problem is. Example: I'm always frustrated when [...]

**Describe the solution you'd like**

A clear and concise description of what you want to happen.

Links to related tickets or other information are welcome here.

**Describe alternatives you've considered**

A clear and concise description of any alternative solutions or features you've considered.

**Additional context**

Add any other context or screenshots about the feature request here.
47 changes: 47 additions & 0 deletions pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## [{ticket number/type}:] {title}

### Description :memo:

- **Purpose**: What issue does this PR address or what feature does it implement?
- **Approach**: How does this PR tackle the problem?

**Type of change**

*Delete options that are not relevant.*

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

**Updates**

:point_right:
:point_right:
:point_right:

### Screenshots :camera:

{Image here of before and after - if applicable}

### Test plan :test_tube:

*Provide guidance for how to QA your proposed changes. This is not only for a test but also useful for a reviewer.*

{A test plan outlining scenarios to test}

### Author to check :eyeglasses:

- [ ] Project and all contained modules builds successfully
- [ ] Self-/dev-tested
- [ ] Unit/UI/Automation/Integration tests provided where applicable
- [ ] Code is written to standards
- [ ] Appropriate documentation written (code comments, internal docs)

### Reviewer to check :heavy_check_mark:

- [ ] Project and all contained modules builds successfully
- [ ] Change has been dev-/reviewer-tested, where possible
- [ ] Unit/UI/Automation/Integration tests provided where applicable
- [ ] Code is written to standards
- [ ] Appropriate documentation written (code comments, internal docs)

0 comments on commit 2c9f9df

Please sign in to comment.