Skip to content

Commit 66940b6

Browse files
authored
Adding PR/Issue templates (#163)
* Add PR template * Create bug_report.md * Create feature_request.md
1 parent 75a60b8 commit 66940b6

3 files changed

Lines changed: 98 additions & 0 deletions

File tree

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Version Information (Put N/A for Not Applicable)**
11+
| Software | Version(s) |
12+
| ---------------------------| --------------- |
13+
| Linux | |
14+
| Windows | |
15+
| Git | |
16+
| CMake | |
17+
| Compiler (GCC, Clang, etc.)| |
18+
| Doxygen | |
19+
| Documentation | |
20+
21+
**Describe the bug**\
22+
A clear and concise description of what the bug is.
23+
24+
**To Reproduce**\
25+
Steps to reproduce the behavior:
26+
1. Go to '...'
27+
2. Click on '....'
28+
3. Scroll down to '....'
29+
4. etc.
30+
5. See error
31+
32+
**Expected behavior**\
33+
A clear and concise description of what you expected to happen.
34+
35+
**Screenshots**\
36+
If applicable, add screenshots to help explain your problem.
37+
38+
**Additional context**\
39+
Add any other context about the problem here.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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
12+
frustrated when [...]_
13+
14+
**Describe the solution you would like**\
15+
A clear and concise description of what you want to happen.
16+
17+
**Describe alternatives you have considered**\
18+
A clear and concise description of any alternative solutions or features you
19+
have considered.
20+
21+
**Additional context**\
22+
Add any other context or screenshots about the feature request here.
23+
24+
**If the feature request is approved, would you be willing to submit a PR**\
25+
Yes / No _(Help can be provided if you need assistance submitting a PR)_

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Proposed changes
2+
3+
Describe the big picture of your changes here to communicate to the maintainers
4+
why we should accept this pull request. If it fixes a bug or resolves a feature
5+
request, be sure to link to that issue.
6+
7+
## Types of changes
8+
9+
What types of changes does your code introduce to the Encrypted Computing SDK project?
10+
_Put an `x` in the boxes that apply_
11+
12+
- [ ] Bugfix (non-breaking change which fixes an issue)
13+
- [ ] New feature (non-breaking change which adds functionality)
14+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
15+
- [ ] Documentation update (if none of the other choices apply)
16+
17+
## Checklist
18+
19+
_Put an `x` in the boxes that apply. You can also fill these out after creating
20+
the PR. If you are unsure about any of them, do not hesitate to ask. We are
21+
here to help! This is simply a reminder of what we are going to look for before
22+
merging your code._
23+
24+
- [ ] I have read the [CONTRIBUTING](https://github.com/IntelLabs/hexl/blob/development/CONTRIBUTING.md) agreement
25+
- [ ] Current formatting and unit tests / base functionality passes locally with my changes
26+
- [ ] I have added tests that prove my fix is effective or that my feature works (if appropriate)
27+
- [ ] I have added necessary documentation (if appropriate)
28+
- [ ] Any dependent changes have been merged and published in downstream modules
29+
30+
## Further comments
31+
32+
If this is a relatively large or complex change, kick off the discussion by
33+
explaining why you chose the solution you did, what alternatives you
34+
considered, etc.

0 commit comments

Comments
 (0)