diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..a6a0f47c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Version Information (Put N/A for Not Applicable)** +| Software | Version(s) | +| ---------------------------| --------------- | +| Linux | | +| Windows | | +| Git | | +| CMake | | +| Compiler (GCC, Clang, etc.)| | +| Doxygen | | +| Documentation | | + +**Describe the bug**\ +A clear and concise description of what the bug is. + +**To Reproduce**\ +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. etc. +5. See error + +**Expected behavior**\ +A clear and concise description of what you expected to happen. + +**Screenshots**\ +If applicable, add screenshots to help explain your problem. + +**Additional context**\ +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..8f37585e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,25 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +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 [...]_ + +**Describe the solution you would like**\ +A clear and concise description of what you want to happen. + +**Describe alternatives you have considered**\ +A clear and concise description of any alternative solutions or features you +have considered. + +**Additional context**\ +Add any other context or screenshots about the feature request here. + +**If the feature request is approved, would you be willing to submit a PR**\ +Yes / No _(Help can be provided if you need assistance submitting a PR)_ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..8e5b9c80 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ +## Proposed changes + +Describe the big picture of your changes here to communicate to the maintainers +why we should accept this pull request. If it fixes a bug or resolves a feature +request, be sure to link to that issue. + +## Types of changes + +What types of changes does your code introduce to the Encrypted Computing SDK project? +_Put an `x` in the boxes that apply_ + +- [ ] Bugfix (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 not work as expected) +- [ ] Documentation update (if none of the other choices apply) + +## Checklist + +_Put an `x` in the boxes that apply. You can also fill these out after creating +the PR. If you are unsure about any of them, do not hesitate to ask. We are +here to help! This is simply a reminder of what we are going to look for before +merging your code._ + +- [ ] I have read the [CONTRIBUTING](https://github.com/IntelLabs/hexl/blob/development/CONTRIBUTING.md) agreement +- [ ] Current formatting and unit tests / base functionality passes locally with my changes +- [ ] I have added tests that prove my fix is effective or that my feature works (if appropriate) +- [ ] I have added necessary documentation (if appropriate) +- [ ] Any dependent changes have been merged and published in downstream modules + +## Further comments + +If this is a relatively large or complex change, kick off the discussion by +explaining why you chose the solution you did, what alternatives you +considered, etc.