Skip to content
This repository was archived by the owner on Mar 20, 2023. It is now read-only.

Commit c5f6563

Browse files
authored
Update Ιssue and PR templates (#434)
* Added Issue templates for bugs and new features * Added PR template
1 parent d4dd066 commit c5f6563

File tree

4 files changed

+88
-0
lines changed

4 files changed

+88
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the issue**
11+
A clear and concise description of what the issue is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
```bash
16+
A simple script
17+
```
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Logs**
23+
If possible attach helpful logs related to the issue.
24+
If there is an issue during build `CMakeError.log`, `CMakeOutput.log` or the output of `make VERBOSE=1` would be helpful.
25+
Otherwise any error printed to the therminal.
26+
27+
**System (please complete the following information)**
28+
- OS: [e.g. Ubuntu 20.04]
29+
- Compiler: [e.g. PGI 20.9]
30+
- Version: [e.g. master branch]
31+
- Backend: [e.g. CPU]
32+
33+
**Additional context**
34+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context about the feature request here.

.github/pull_request_template.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
**Description**
2+
3+
Please include a summary of the change and which issue is fixed or which feature is added.
4+
5+
- [ ] Issue 1 fixed
6+
- [ ] Issue 2 fixed
7+
- [ ] Feature 1 added
8+
- [ ] Feature 2 added
9+
10+
Fixes # (issue)
11+
12+
**How to test this?**
13+
14+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce if there is no integration test added with this PR. Please also list any relevant details for your test configuration
15+
16+
```bash
17+
cmake ..
18+
make -j8
19+
nrnivmodl mod
20+
./bin/nrnivmodl-core mod
21+
./x86_64/special script.py
22+
./x86_64/special-core --tstop=10 --datpath=coredat
23+
```
24+
25+
**Test System**
26+
- OS: [e.g. Ubuntu 20.04]
27+
- Compiler: [e.g. PGI 20.9]
28+
- Version: [e.g. master branch]
29+
- Backend: [e.g. CPU]
30+
31+
**Use certain branches for the SimulationStack CI**
32+
33+
CI_BRANCHES:NEURON_BRANCH=master,

0 commit comments

Comments
 (0)