docs(project): adding project contributing guides (#99)

Signed-off-by: Pawan <pawan@mayadata.io>
This commit is contained in:
Pawan Prakash Sharma 2020-04-30 00:22:52 +05:30 committed by GitHub
parent 02bc587c08
commit f65575e447
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 154 additions and 0 deletions

32
.github/ISSUE_TEMPLATE/bug-report.md vendored Normal file
View file

@ -0,0 +1,32 @@
---
name: Bug report
about: Tell us about a problem you are experiencing
labels: Bug
---
**What steps did you take and what happened:**
[A clear and concise description of what the bug is, and what commands you ran.]
**What did you expect to happen:**
**The output of the following commands will help us better understand what's going on**:
(Pasting long output into a [GitHub gist](https://gist.github.com) or other [Pastebin](https://pastebin.com/) is fine.)
* `kubectl logs -f openebs-zfs-controller-0 -n kube-system -c openebs-zfs-plugin`
* `kubectl logs -f openebs-zfs-node-[xxxx] -n kube-system -c openebs-zfs-plugin`
* `kubectl get pods -n kube-system`
* `kubectl get zv -A -o yaml`
**Anything else you would like to add:**
[Miscellaneous information that will assist in solving the issue.]
**Environment:**
- ZFS-LocalPV version
- Kubernetes version (use `kubectl version`):
- Kubernetes installer & version:
- Cloud provider or hardware configuration:
- OS (e.g. from `/etc/os-release`):

View file

@ -0,0 +1,25 @@
---
name: Feature request
about: Suggest an idea for this project
labels: Enhancement
---
**Describe the problem/challenge you have**
[A description of the current limitation/problem/challenge that you are experiencing.]
**Describe the solution you'd like**
[A clear and concise description of what you want to happen.]
**Anything else you would like to add:**
[Miscellaneous information that will assist in solving the issue.]
**Environment:**
- ZFS-LocalPV version
- Kubernetes version (use `kubectl version`):
- Kubernetes installer & version:
- Cloud provider or hardware configuration:
- OS (e.g. from `/etc/os-release`):

51
.github/pull_request_template.md vendored Normal file
View file

@ -0,0 +1,51 @@
## Pull Request template
Please, go through these steps before you submit a PR.
**Why is this PR required? What issue does it fix?**:
**What this PR does?**:
**Does this PR require any upgrade changes?**:
**If the changes in this PR are manually verified, list down the scenarios covered:**:
**Any additional information for your reviewer?** :
_Mention if this PR is part of any design or a continuation of previous PRs_
**Checklist:**
- [ ] Fixes #<issue number>
- [ ] PR Title follows the convention of `<type>(<scope>): <subject>`
- [ ] Has the change log section been updated?
- [ ] Commit has unit tests
- [ ] Commit has integration tests
- [ ] (Optional) Are upgrade changes included in this PR? If not, mention the issue/PR to track:
- [ ] (Optional) If documentation changes are required, which issue on https://github.com/openebs/openebs-docs is used to track them:
**PLEASE REMOVE BELOW INFORMATION BEFORE SUBMITTING**
The PR title message must follow convention:
`<type>(<scope>): <subject>`.
Where: <br />
- `type` is defining if release will be triggering after merging submitted changes, details in [CONTRIBUTING.md](../CONTRIBUTING.md).
Most common types are:
- `feat` - for new features, not a new feature for build script
- `fix` - for bug fixes or improvements, not a fix for build script
- `chore` - changes not related to production code
- `docs` - changes related to documentation
- `style` - formatting, missing semi colons, linting fix etc; no significant production code changes
- `test` - adding missing tests, refactoring tests; no production code change
- `refactor` - refactoring production code, eg. renaming a variable or function name, there should not be any significant production code changes
- `scope` is a single word that best describes where the changes fit.
Most common scopes are like:
- data engine (`localpv`, `jiva`, `cstor`)
- feature (`provisioning`, `backup`, `restore`, `exporter`)
- code component (`api`, `webhook`, `cast`, `upgrade`)
- test (`tests`, `bdd`)
- chores (`version`, `build`, `log`, `travis`)
- `subject` is a single line brief description of the changes made in the pull request.