Skip to content

Commit

Permalink
chore: improve issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
rhamzeh committed Feb 27, 2024
1 parent 40f2ad6 commit a7fa5f1
Show file tree
Hide file tree
Showing 4 changed files with 176 additions and 2 deletions.
101 changes: 101 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
name: 🐛 Report a bug
description: Have you found a bug or issue? Create a bug report for OpenFGA
labels: [ "bug" ]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: markdown
attributes:
value: |
**Please do not report security vulnerabilities here**. Use https://github.com/openfga/dotnet-sdk/security/advisories/new or send us an email at security@openfga.dev instead.
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I have looked into the [README](https://github.com/openfga/dotnet-sdk/blob/main/README.md) and have not found a suitable solution or answer.
required: true
- label: I have looked into the [documentation](https://openfga.dev/docs) and have not found a suitable solution or answer.
required: true
- label: I have searched the [issues](https://github.com/openfga/dotnet-sdk/issues) and have not found a suitable solution or answer.
required: true
- label: I have upgraded to the [latest version](https://github.com/openfga/dotnet-sdk/releases/latest) of OpenFGA and the issue still persists.
required: true
- label: I have searched the [Slack community](https://openfga.dev/community) and have not found a suitable solution or answer.
required: true
- label: I agree to the terms within the [OpenFGA Code of Conduct](https://github.com/openfga/.github/blob/main/CODE_OF_CONDUCT.md).
required: true

- type: textarea
id: description
attributes:
label: Description
description: Provide a clear and concise description of the issue.
validations:
required: true

- type: textarea
id: expectation
attributes:
label: Expectation
description: Tell us about the behavior you expected to see.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction
description: Detail the steps taken to reproduce this error and, ideally, share a repo of a minimal reproducible example. State whether this issue can be reproduced consistently or if it is intermittent.
placeholder: |
1. Given...
2. When...
3. Then...
validations:
required: true

- type: input
id: environment-sdk-version
attributes:
label: OpenFGA SDK version
description: The version of .NET SDK for OpenFGA you're using.
validations:
required: true

- type: input
id: environment-openfga-version
attributes:
label: OpenFGA version
description: The version of OpenFGA you're using.
validations:
required: true

- type: input
id: environment-sdk-config
attributes:
label: SDK Configuration
description: How are you initializing the SDK (DO NOT SHARE ANY SECRETS)
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs
description: Do you have any logs or traces that could help us debug the problem?
validations:
required: false

- type: textarea
id: references
attributes:
label: References
description: Any references to other issues, PRs, documentation or other links
validations:
required: false

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: 📖 OpenFGA's Documentation
url: https://openfga.dev/docs
about: Check OpenFGA's documentation for an in-depth overview
- name: 👽 Community
url: https://openfga.dev/community
about: Join OpenFGA's community on Slack and GitHub Discussions
- name: 📝 RFCs
url: https://github.com/openfga/rfcs
about: Check existing RFCs to understand where the project is headed
- name: 💬 Discussions
url: https://github.com/orgs/openfga/discussions
about: Start a discussion about your authorization needs or questions
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: 🚀 Feature Request
description: Suggest an idea or a feature for this project
labels: [ "enhancement" ]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I agree to the terms within the [OpenFGA Code of Conduct](https://github.com/openfga/.github/blob/main/CODE_OF_CONDUCT.md).
required: true

- type: textarea
id: description
attributes:
label: Describe the problem you'd like to have solved
description: A clear and concise description of what the problem is.
placeholder: My life would be a lot simpler if...
validations:
required: true

- type: textarea
id: ideal-solution
attributes:
label: Describe the ideal solution
description: A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: alternatives-and-workarounds
attributes:
label: Alternatives and current workarounds
description: A clear and concise description of any alternatives you've considered or any workarounds that are currently in place.
validations:
required: false

- type: textarea
id: references
attributes:
label: References
description: Any references to other issues, PRs, documentation or other links
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
5 changes: 3 additions & 2 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.editorconfig
.fossa.yml
.github/CODEOWNERS
.github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/feature_request.md
.github/ISSUE_TEMPLATE/bug_report.yaml
.github/ISSUE_TEMPLATE/config.yaml
.github/ISSUE_TEMPLATE/feature_request.yaml
.github/dependabot.yaml
.github/workflows/main.yaml
.github/workflows/semgrep.yaml
Expand Down

0 comments on commit a7fa5f1

Please sign in to comment.