diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..37100bf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,42 @@ +--- +name: Bug +about: Create a bug report to help us improve +title: '' +labels: component/conjur-sdk, kind/bug +assignees: '' + +--- + +## Summary +A clear and concise description of what the bug is. + +## Steps to Reproduce +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Expected Results +A clear and concise description of what you expected to happen. + +## Actual Results (including error logs, if applicable) +A clear and concise description of what actually did happen. + +## Reproducible + * [ ] Always + * [ ] Sometimes + * [ ] Non-Reproducible + +## Version/Tag number +What version of the product are you running? Any version info that you can share is helpful. +For example, you might give the version from Docker logs, the Docker tag, a specific download URL, +the output of the `/info` route, etc. + +## Environment setup +Can you describe the environment in which this product is running? Is it running on a VM / in a container / in a cloud? +Which cloud provider? Which container orchestrator (including version)? +The more info you can share about your runtime environment, the better we may be able to reproduce the issue. + +## Additional Information +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 0000000..0b16f10 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,27 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: kind/enhancement, component/conjur-sdk +assignees: '' + +--- + +## Is your feature request related to a problem? Please describe. + +A clear and concise description of what the problem is. Ex. `I would like to see [...] because [...]`. +Please include the intended use case and what the feature would improve on so that we can prioritize +the feature accordingly. + +## Describe the solution you would like + +A clear and concise description of what the desired end result(s) would be. + +## Describe alternatives you have considered + +A clear and concise description of any alternative solutions or features that may be related to this that +you have considered. + +## Additional context + +Add any other context information about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..7d05f92 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +### What does this PR do? +- _What's changed? Why were these changes made?_ +- _How should the reviewer approach this PR, especially if manual tests are required?_ +- _Are there relevant screenshots you can add to the PR description?_ + +### What ticket does this PR close? +Resolves #[relevant GitHub issues, eg 76] +Relates to cyberark/conjur-openapi-spec#[Relevant Conjur OpenAPI spec issue number] + +### Checklists + +#### Change log +- [ ] The CHANGELOG has been updated, or +- [ ] This PR does not include user-facing changes and doesn't require a CHANGELOG update + +#### Test coverage +- [ ] This PR includes new unit and integration tests to go with the code changes, or +- [ ] The changes in this PR do not require tests + +#### Documentation +- [ ] Docs (e.g. `README`s) were updated in this PR, and/or there is a follow-on issue to update docs, or +- [ ] This PR does not require updating any documentation