Skip to content

Commit

Permalink
Added new PR & issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
telday committed May 6, 2021
1 parent 5a38998 commit 06368e6
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -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.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -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.
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 06368e6

Please sign in to comment.