Skip to content

Commit

Permalink
Maintenance: GitHub Issues and PR Templates (#478)
Browse files Browse the repository at this point in the history
Adds templates for issues and PRs.

---------

Co-authored-by: Daniel R. Reynolds <[email protected]>
  • Loading branch information
balos1 and drreynolds authored May 15, 2024
1 parent 2abd63b commit b685654
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Bug
about: File a bug report
title: '[BUG] <title>'
labels: bug, triage
assignees: ''

---

<!--
Note: Please search to see if an issue already exists for the bug you encountered.
-->

### Current Behavior:
<!-- A concise description of what you're experiencing. -->

### Expected Behavior:
<!-- A concise description of what you expected to happen. -->

### Steps To Reproduce:
<!--
Example: steps to reproduce the behavior:
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
-->

### Environment:
<!--
Example:
- SUNDIALS version: 7.0.0
- OS: Ubuntu 20.04
- Compiler: gcc 8.5.0
-->

### Anything else:
<!--
Links? References? Anything that will give us more context about the issue that you are encountering!
-->
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: General/Question
about: File an issue for something that is not a bug
title: '<title>'
labels: triage
assignees: ''

---
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

<!-- SUNDIALS developers only: remove the checklist before opening a PR and refer to the developer's guide instructions. -->
<!-- Thank you for your interest in contributing to SUNDIALS. A pull request to SUNDIALS requires the following steps to be completed: -->

- [ ] Please target the `develop` branch not `main`.
- [ ] Review our [Contributing Guide](https://github.com/LLNL/sundials/blob/main/CONTRIBUTING.md), and ensure that you sign your last commit (at minimum) as per the guide.
- [ ] Provide a concise description of what your pull request does, and why it is needed/benefical.
- [ ] Add a note about your change to the `CHANGELOG.md` and `docs/shared/RecentChanges.rst` files. Notice that the former is a markdown file and the latter is reStructuredText, so the formatting is slightly different.
- [ ] After your PR is opened, ensure that all of the tests are passing (a SUNDIALS developer will have to allow the testing to run).

Empty file.

0 comments on commit b685654

Please sign in to comment.