diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..7a457276e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Help us to improve this project + +--- +**Please check the FAQ documentation before raising an issue** + +Please check the old issues before raising an issue in case someone has asked the same question that you are asking. + +**Describe the bug (__must be provided__)** + +A clear and concise description of what the bug is. + +**Your Environments (__must be provided__)** + +* OS: `uname -a` +* Compliler: `g++ --version` or `clang++ --version` +* CPU: `lscpu` +* Commit id (e.g. `a3ffc7d8`) + +**How To Reproduce(__must be provided__)** + +Steps to reproduce the behavior: + +1. Step 1 +2. Step 2 +3. Step 3 + +**Expected behavior** + +A clear and concise description of what you expected to happen. + +**Additional context** + +Provide logs and configs, or any other context to trace the problem. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..066b2d920 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**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 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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..f3dffaf07 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,58 @@ + + +### What changes were proposed in this pull request? + + + + +### Why are the changes needed? + + + + +### Will break the compatibility? How if so? + + + + + +### Does this PR introduce any user-facing change? + + + + +### How was this patch tested? + + + +### Checklist + + +- [ ] I've run the tests to see all new and existing tests pass. +- [ ] If this Pull Request resolves an issue, I linked to the issue in the text above. +- [ ] I've informed the technical writer about the documentation change if necessary.