diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..32424a16 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -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/java-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/java-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/java-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/java-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 Java 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 + diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 00000000..17b9ef01 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..dbd872d8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -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 diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index bcb36ee7..b0f2bcf5 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -1,7 +1,8 @@ .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.yml .github/workflows/semgrep.yaml