diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..0e7de05 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,40 @@ +### Prerequisites + +Put an `x` into the box that applies: + +- [ ] This issue describes a bug. +- [ ] This issue describes a feature request. + +For more information, see the [Contributing Guidelines](https://github.com/cloud-ca/cca/tree/master/CONTRIBUTING.md). + +### Description + +Briefly describe the issue. + +#### Actual Behavior + +Briefly describe what happened. + +``` +``` + +Do you have long logs to share? Please go to https://ghostbin.com and insert the link here. + +#### Expected Behavior + +Briefly describe what you expected to happen. + +``` +``` + +### Replication Case + +Tell us which steps to take to replicate your problem. + +1. ... +2. ... +3. ... + +### Version + +You can get this information via `cca --version`. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..8c5763b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,39 @@ +### Prerequisites + +Put an `x` into the box(es) that apply: + +- [ ] This pull request fixes a bug. +- [ ] This pull request adds a feature. +- [ ] This pull request enhances existing functionality. +- [ ] This pull request introduces breaking change. + +For more information, see the [Contributing Guide](https://github.com/cloud-ca/cca/tree/master/CONTRIBUTING.md). + +### Description + +Describe what this pull request achieves. Ensure you have read the [Contributing Guidelines](https://github.com/cloud-ca/cca/tree/master/CONTRIBUTING.md) document before submitting. + +### Issues Resolved + +List any existing issues this pull request resolves. + +### Checklist + +Put an `x` into all boxes that apply: + +- [ ] I have read the [Contributing Guidelines](https://github.com/cloud-ca/cca/tree/master/CONTRIBUTING.md). + +#### Tests + +- [ ] I have added tests to cover my changes. +- [ ] All tests pass when I run `make test`. + +#### Documentation + +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. + +#### Code Style + +- [ ] My code follows the code style of this project. +- [ ] All checks pass when I run `make checkfmt` and `make lint`.