Skip to content

Commit

Permalink
Improved GitHub Forms (Issues/PRs) (westpa#390)
Browse files Browse the repository at this point in the history
* make github issues template description text disappear

* comments need to be on new lines

* but not on numbered points

* make issues section headers actual headers

* two lines at the end of templates

* remove period after each section header
  • Loading branch information
jeremyleung521 authored Mar 28, 2024
1 parent 562e17f commit f44c3cf
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 22 deletions.
30 changes: 18 additions & 12 deletions .github/ISSUE_TEMPLATE/bug_report_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,37 @@ assignees: ''

---

### Prerequisites

## Prerequisites
* [ ] Can you reproduce the problem in safe mode?
* [ ] Are you running the latest version?
* [ ] Are you reporting to the correct repository?
* [ ] Did you perform a cursory search?

For more information, see the `CONTRIBUTING` guide.
<!--- For more information, see the `CONTRIBUTING` guide. --->

## Describe the bug
<!--- A clear and concise description of what the bug is. --->

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

## To Reproduce
<!--- Steps to reproduce the behavior: --->
1. <!--- [First Step] --->
2. <!--- [Second Step] --->
3. <!--- [and so on...] --->

**To Reproduce.** Steps to reproduce the behavior:
1. [First Step]
2. [Second Step]
3. [and so on...]
## Expected behavior
<!--- A clear and concise description of what you expected to happen. -->

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

## Actual behavior
<!--- A clear and concise description of what actually happens. --->

**Actual behavior.** A clear and concise description of what actually happens.

## WESTPA version and platform
<!--- Which version you're running, on what OS, and how it was built (e.g. conda, system libraries, manually installed dependencies) --->

**WESTPA version and platform.** Which version you're running, on what OS, and how it was built (e.g. conda, system libraries, manually installed dependencies)

## Additional context
<!--- Add any other context about the problem here. If necessary config files are required to reproduce the bug, attach the files here here. --->

**Additional context.** Add any other context about the problem here. If necessary config files are required to reproduce the bug, attach the files here here.

13 changes: 9 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,19 @@ assignees: ''

---

**Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Is your feature request related to a problem? Please describe
<!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --->


**Describe the solution you'd like.** A clear and concise description of what you want to happen.
## Describe the solution you'd like
<!--- A clear and concise description of what you want to happen. --->


**Describe alternatives you've considered.** A clear and concise description of any alternative solutions or features you've considered.
## 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.
## Additional context
<!--- Add any other context or screenshots about the feature request here. --->


19 changes: 13 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
**Issue Number.** Is this pull request related to any outstanding issues? If so, list the issue number.
## Issue Number
<!--- Is this pull request related to any outstanding issues? If so, list the issue number. --->


**Describe the changes made.** A clear and concise description of what the problem is and what you did to fix it. E.g. [...] was happening and I've changed [...] to fix it.
## Describe the changes made
<!--- A clear and concise description of what the problem is and what you did to fix it. E.g. [...] was happening and I've changed [...] to fix it. -->


**Goals and Outstanding Issues.** A clear and concise list of goals (to be) accomplished.
## Goals and Outstanding Issues
<!--- A clear and concise list of goals (to be) accomplished. --->
- [ ]

**Major files changed.**
## Major files changed
<!--- Manually list files or include a diff link in the form of: https://github.com/user/westpa/compare/<initial SHA>..<final SHA> --->
- [ ]

**Status.**
## Status
<!--- Delete bullet points 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 change)
Expand All @@ -21,5 +26,7 @@
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

**Additional context.** Add any other context or screenshots about the pull request here.
## Additional context
<!--- Add any other context or screenshots about the pull request here. --->


0 comments on commit f44c3cf

Please sign in to comment.