Skip to content

Commit

Permalink
Adjust issue template and PR template to fit OpenBao
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Savchyn <dev@scorpil.com>
  • Loading branch information
Scorpil committed Nov 30, 2023
1 parent 44fdf3b commit 0b1971e
Show file tree
Hide file tree
Showing 7 changed files with 189 additions and 75 deletions.
48 changes: 0 additions & 48 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

18 changes: 9 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
name: Bug report
about: Let us know about a bug!
title: ''
labels: ''
labels: 'bug,pending-decision'
assignees: ''

---

<!-- Please reserve GitHub issues for bug reports and feature requests.
For questions, the best place to get answers is on our [discussion forum](https://discuss.hashicorp.com/c/vault), as they will get more visibility from experienced users than the issue tracker.
For questions, the best place to get answers is on our [mailing list](https://lists.lfedge.org/g/openbao), as they will get more visibility from experienced users than the issue tracker.
Please note: We take Vault's security and our users' trust very seriously. If you believe you have found a security issue in Vault, please responsibly disclose by contacting us at security@hashicorp.com. Our PGP key is available at [our security page](https://www.hashicorp.com/security/).
Please note: We take OpenBao's security and our users' trust very seriously. If you believe you have found a security issue in OpenBao, please responsibly disclose by contacting us at TODO: security email. Our PGP key is available at [TODO: our security page](TODO).
-->

Expand All @@ -20,22 +20,22 @@ A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Run `vault write ...`
2. Run `vault login....`
1. Run `bao write ...`
2. Run `bao login....`
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Environment:**
* Vault Server Version (retrieve with `vault status`):
* Vault CLI Version (retrieve with `vault version`):
* OpenBao Server Version (retrieve with `bao status`):
* OpenBao CLI Version (retrieve with `bao version`):
* Server Operating System/Architecture:

Vault server configuration file(s):
OpenBao server configuration file(s):

```hcl
# Paste your Vault config here.
# Paste your OpenBao config here.
# Be sure to scrub any sensitive values
```

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@

contact_links:
- name: Ask a question
url: https://discuss.hashicorp.com/c/vault
about: For increased visibility, please post questions on the discussion forum.
url: https://lists.lfedge.org/g/openbao
about: For questions, please send questions to our mailing list
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Feature request
about: Suggest something!
title: ''
labels: ''
labels: 'feature,pending-decision'
assignees: ''

---
Expand Down
15 changes: 0 additions & 15 deletions .github/ISSUE_TEMPLATE/plugin-submission.md

This file was deleted.

145 changes: 145 additions & 0 deletions .github/ISSUE_TEMPLATE/rfc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# This RFC has been inspired by the Rust RFC template https://github.com/rust-lang/rfcs/blob/master/0000-template.md
# and by OpenTofu RFC template: https://github.com/opentofu/opentofu/blob/main/.github/ISSUE_TEMPLATE/rfc.yml

name: Submit RFC
description: Submit a highly-structured change request for public discussion.
labels: ["rfc", "pending-decision"]
body:
- type: markdown
attributes:
value: |
Thank you for opening an RFC!
RFCs are a highly-structured format for submitting change requests. All major changes to OpenBao should first go through an RFC, to have a place for the community to discuss.
The template has a lot of fields and is inspired by the Rust RFC template. Please take your time to fill it out carefully.
Working experimental PoCs in a draft Pull Request are a very welcome attachment to an RFC, especially ones that are easy to check out and take for a spin.
- type: textarea
id: summary
attributes:
label: Summary
description: |
One paragraph explanation of the feature.
placeholder:
value:
validations:
required: true

- type: textarea
id: problem-statement
attributes:
label: Problem Statement
description: |
Why are we doing this? What problem are we solving?
placeholder:
value:
validations:
required: true

- type: textarea
id: user-facing-description
attributes:
label: User-facing description
description: |
Please describe in detail how the feature would work from the perspective of somebody using:
- How can the feature be used?
- How would you explain the feature to somebody?
- Please provide examples of the feature in action.
placeholder:
value:
validations:
required: true

- type: textarea
id: technical-description
attributes:
label: Technical Description
description: |
Please describe in detail how the feature would work from a technical perspective:
- Which components of OpenBao would be involved in the change?
- How would the components need to change?
- Are there any interactions with other features that should be mentioned?
- Are the any edge cases of the feature that should be discussed?
placeholder:
value:
validations:
required: true

- type: textarea
id: rationale-and-alternatives
attributes:
label: Rationale and alternatives
description: |
- What would be the impact of this feature?
- Why is this solution better than alternative solutions to this problem, if there are any?
- How would the OpenBao user experience suffer if we didn't do this.
placeholder:
value:
validations:
required: true

- type: textarea
id: downsides
attributes:
label: Downsides
description: |
- Are there any disadvantages of implementing this?
placeholder:
value:
validations:
required: false

- type: textarea
id: security
attributes:
label: Security Implications
description: |
- Are there any impact on OpenBao's security?
placeholder:
value:
validations:
required: false

- type: textarea
id: unresolved-questions
attributes:
label: Unresolved Questions
description: |
- Are there any specific parts of the feature you're not sure about?
- Are there any specific parts of the technical implementation you're not sure about?
- Are there any other questions or unknowns that need to be answered before implementing this?
placeholder:
value:
validations:
required: false

- type: textarea
id: related-issues
attributes:
label: Related Issues
description: |
- Please post any issues or RFCs related to this one.
placeholder:
value:
validations:
required: false

- type: textarea
id: poc-pull-request
attributes:
label: Proof of Concept
description: |
- If there is a Pull Request with a Proof of Concept, please link it here.
- Please concisely describe how to take the PoC for a spin.
placeholder:
value:
validations:
required: false

- type: markdown
attributes:
value: |
**Note:** If the submit button is disabled and you have filled out all required fields, please check that you did not forget a **Title** for the issue.
32 changes: 32 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!--
Describe in detail the changes you are proposing, and the rationale.
See the contributing guide:
https://github.com/lf-edge/openbao/blob/development/CONTRIBUTING.md
-->

<!--
Link all GitHub issues fixed by this PR, and add references to prior related PRs.
Make sure to first open an issue, get community approval and only then create Pull Request to resolve it.
All Pull Requests must have an issue attached to them
-->

Resolves #

## Target Release

<!--
In normal circumstances we only target changes at the upcoming minor
release, or as a patch to the current minor version. If you need to
port a security fix to an older release, highlight this here by listing
all targeted releases.
-->

1.14.7

0 comments on commit 0b1971e

Please sign in to comment.