Merge pull request #36 from Amber1990Zhang/add-commit-msg
add pr and issue template
This commit is contained in:
commit
a961030392
35
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
35
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
@ -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.
|
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@ -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.
|
58
.github/pull_request_template.md
vendored
Normal file
58
.github/pull_request_template.md
vendored
Normal file
@ -0,0 +1,58 @@
|
||||
<!--
|
||||
Thank you for contributing to **OceanBase**! Please read the [CONTRIBUTING](https://github.com/oceanbase/oceanbase/blob/master/CONTRIBUTING.md) document **BEFORE** filing this PR.
|
||||
-->
|
||||
|
||||
### What changes were proposed in this pull request?
|
||||
|
||||
<!--
|
||||
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
|
||||
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
|
||||
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
|
||||
2. If you fix some nGQL features, you can provide some references.
|
||||
3. If there is design documentation, please add the link.
|
||||
4. If there is a discussion in the mailing list, please add the link.
|
||||
-->
|
||||
|
||||
|
||||
### Why are the changes needed?
|
||||
|
||||
<!--
|
||||
Please clarify why the changes are needed. For instance,
|
||||
1. If you propose a new API, clarify the use case for a new API.
|
||||
2. If you fix a bug, you can clarify why it is a bug.
|
||||
-->
|
||||
|
||||
|
||||
### Will break the compatibility? How if so?
|
||||
|
||||
|
||||
<!--
|
||||
Please label `alert/break' if so, such as
|
||||
1. nGQL grammar changes;
|
||||
2. RPC protocol can't be compatible with previous, refer to https://diwakergupta.github.io/thrift-missing-guide/#_versioning_compatibility;
|
||||
3. Storage format; etc.
|
||||
-->
|
||||
|
||||
|
||||
### Does this PR introduce any user-facing change?
|
||||
|
||||
<!--
|
||||
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
|
||||
If no, write 'No'.
|
||||
-->
|
||||
|
||||
|
||||
### How was this patch tested?
|
||||
|
||||
<!--
|
||||
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
|
||||
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
|
||||
If tests were not added, please describe why they were not added and/or why it was difficult to add.
|
||||
-->
|
||||
|
||||
### Checklist
|
||||
<!--Tick the checkbox(es) below to choose what you have done.-->
|
||||
|
||||
- [ ] 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.
|
Loading…
x
Reference in New Issue
Block a user