Skip to content

Commit

Permalink
Merge pull request #5 from NASA-AMMOS/riverma-github-templates
Browse files Browse the repository at this point in the history
Proposed GitHub templates for bugs, feature requests, and pull requests
  • Loading branch information
jpl-jengelke authored Nov 28, 2022
2 parents 7980707 + fefe1bd commit 84667e8
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: Bug Report
about: Report a bug to help us improve
title: '[Bug]: '
labels: 'bug'
assignees: ''

---

**Checked for duplicates**

> Have you checked for duplicate issue tickets?
- Ex. Yes - I've already checked
- Ex. No - I haven't checked

**Describe the bug**

> A clear and concise description of what the bug is. Plain-text snippets preferred but screenshots welcome.
Ex. When I did [...] action, I noticed [...]

**What did you expect?**

> A clear and concise description of what you expect to happen
Ex. I expected [...]

**Reproducible steps**

> How would we reproduce this bug? Please walk us through it step by step. Plain-text snippets preferred but screenshots welcome.
1.
2.
3.

**What is your environment?**

> Include any computer hardware, operating system, framework, browser, time-of-day or other contextual information related to your issue
- Ex. Version of this software [e.g. vX.Y.Z]
- Ex. Operating System: [e.g. MacOSX with Docker Desktop vX.Y]
- ...
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: New Feature
about: Suggest a new feature for us to implement
title: '[New Feature]: '
labels: 'enhancement'
assignees: ''

---

**Checked for duplicates**

> Have you checked for duplicate issue tickets?
- Ex. Yes - I've already checked
- Ex. No - I haven't checked

**Alternatives considered**

> Have you considered alternative solutions to your feature request?
- Ex. Yes - and alternatives don't suffice
- Ex. No - I haven't considered

**Related problems**

> Is your feature request related to any problems? Please help us understand if so, including linking to any other issue tickets.
Ex. I'm frustrated when [...] happens as documented in issue-XYZ

**Describe the feature request**

> A clear and concise description of your request.
Ex. I need or want [...]
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Purpose
- Clear, easy-to-understand sentences outlining the purpose of the PR
## Proposed Changes
- [ADD] ...
- [CHANGE] ...
- [FIX] ...
## Issues
- Links to relevant issues
- Example: issue-XYZ
## Testing
- Provide some proof you've tested your changes
- Example: test results available at ...
- Example: tested on operating system ...

0 comments on commit 84667e8

Please sign in to comment.