Skip to content

Commit 541443d

Browse files
vkreschjdsika
authored andcommitted
Update issue templates (#343)
* Added three types of issue templates * Added pull request template
1 parent 7194aaf commit 541443d

4 files changed

Lines changed: 118 additions & 0 deletions

File tree

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
#### Describe the bug
11+
A clear and concise description of what the bug is.
12+
13+
#### Describe how to reproduce the bug
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
#### Describe the expected behavior
21+
A clear and concise description of what you expected to happen.
22+
23+
#### Show some screenshots
24+
If applicable, add screenshots to help explain your problem.
25+
26+
#### Describe the OS you are using
27+
- OS: [e.g. iOS, Ubuntu 18.04, Windows 10, ...]
28+
- Language: [e.g. C++, Python, ...]
29+
- Version [e.g. 3.6.8]
30+
31+
#### Additional context
32+
Add any other context about the bug here.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: feature request
6+
assignees: ''
7+
8+
---
9+
10+
#### Describe the feature
11+
Is your feature request related to a problem?
12+
A clear and concise description of what the problem is.
13+
Example: I am always frustrated when [...].
14+
15+
#### Describe the solution you would like
16+
A clear and concise description of what you want to happen.
17+
18+
#### Describe alternatives you have considered
19+
A clear and concise description of any alternative solutions or features you have considered.
20+
21+
#### Describe the backwards compatibility
22+
How does the feature impact the backwards compatibility of the current major version of OSI?
23+
If the suggested feature would be implemented would there be an issue with the previous versions of OSI? What part of OSI would break or improve by this feature?
24+
25+
#### Additional context
26+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Question
3+
about: Ask a question if you do not understand something or just want clarifications.
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
#### Describe the problem
11+
I want to do ... in my application, but what I am actually getting is....
12+
Here is a screenshot that illustrates the problem:
13+
14+
`image.png`
15+
16+
#### Describe what you have already tried
17+
This is the most simplified version of my code that I have been able to get, which still produces the problem I described above.
18+
19+
// my code
20+
...
21+
22+
Basically, what the code is doing is....
23+
Changing ... does not work because it gives the following error:
24+
25+
26+
Some error
27+
28+
29+
#### Describe your research
30+
[The documentation here] mentioned ... but did not provide a clear example of how that is done.
31+
[This Stack Overflow question] describes a similar problem, but mine is different because....
32+
33+
#### Ask your question
34+
So my basic question is, how do I...?
35+
36+
#### Additional context
37+
Add any other context or screenshots about the question here.

.github/pull_request_template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#### Reference to a related issue in the repository
2+
Add a reference to a related issue in the repository.
3+
4+
#### Add a description
5+
Add a description of the changes proposed in the pull request.
6+
7+
**Some questions to ask**:
8+
What is this change?
9+
What does it fix?
10+
Is this a bug fix or a feature? Does it break any existing functionality or force me to update to a new version?
11+
How has it been tested?
12+
13+
#### Mention a member
14+
Add @mentions of the person or team responsible for reviewing proposed changes.
15+
16+
#### Check the checklist
17+
18+
- [ ] My code and comments follow the [style guidelines](https://opensimulationinterface.github.io/osi-documentation/osi/commenting.html) and [contributors guidelines](https://opensimulationinterface.github.io/osi-documentation/osi/howtocontribute.html) of this project.
19+
- [ ] I have performed a self-review of my own code.
20+
- [ ] I have made corresponding changes to the [documentation](https://github.com/OpenSimulationInterface/osi-documentation).
21+
- [ ] My changes generate no new warnings.
22+
- [ ] I have added tests that prove my fix is effective or that my feature works.
23+
- [ ] New and existing unit tests / travis ci pass locally with my changes.

0 commit comments

Comments
 (0)