Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update support links and add issue templates #46

Merged
merged 4 commits into from
Feb 28, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 0 additions & 64 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

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
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

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
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATES/bug_report.md

This file was deleted.

30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATES/feature_request.md

This file was deleted.

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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Considering that the SDKs are autogenerated, please make sure to submit your Pul

### Have a question or problem?

Please do not open issues for general support or usage questions. Instead, join us over in the [OpenFGA discussions](https://github.com/orgs/openfga/discussions) or [support community](https://discord.gg/8naAwJfWN6).
Please do not open issues for general support or usage questions. Instead, join us over in the [OpenFGA discussions](https://github.com/orgs/openfga/discussions) or [support community](https://openfga.dev/community).

### Vulnerability Reporting

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Release](https://img.shields.io/github/v/release/openfga/dotnet-sdk?sort=semver&color=green)](https://github.com/openfga/dotnet-sdk/releases)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenfga%2Fdotnet-sdk.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenfga%2Fdotnet-sdk?ref=badge_shield)
[![Discord Server](https://img.shields.io/discord/759188666072825867?color=7289da&logo=discord "Discord Server")](https://discord.gg/8naAwJfWN6)
[![Join our community](https://img.shields.io/badge/slack-cncf_%23openfga-40abb8.svg?logo=slack)](https://openfga.dev/community)
[![Twitter](https://img.shields.io/twitter/follow/openfga?color=%23179CF0&logo=twitter&style=flat-square "@openfga on Twitter")](https://twitter.com/openfga)

This is an autogenerated SDK for OpenFGA. It provides a wrapper around the [OpenFGA API definition](https://openfga.dev/api).
Expand Down Expand Up @@ -60,7 +60,7 @@ OpenFGA is designed to make it easy for application builders to model their perm
- [OpenFGA Documentation](https://openfga.dev/docs)
- [OpenFGA API Documentation](https://openfga.dev/api/service)
- [Twitter](https://twitter.com/openfga)
- [OpenFGA Discord Community](https://discord.gg/8naAwJfWN6)
- [OpenFGA Community](https://openfga.dev/community)
- [Zanzibar Academy](https://zanzibar.academy)
- [Google's Zanzibar Paper (2019)](https://research.google/pubs/pub48190/)

Expand Down Expand Up @@ -92,9 +92,9 @@ Search for and install `OpenFga.Sdk` in each of their respective package manager

[Learn how to initialize your SDK](https://openfga.dev/docs/getting-started/setup-sdk-client)

The documentation below refers to the `OpenFga.SdkClient`, to read the documentation for `OpenFga.SdkApi`, check out the [`v0.2.1` documentation](https://github.com/openfga/dotnet-sdk/tree/v0.2.1#readme).
We strongly recommend you initialize the `OpenFgaClient` only once and then re-use it throughout your app, otherwise you will incur the cost of having to re-initialize multiple times or at every request, the cost of reduced connection pooling and re-use, and would be particularly costly in the client credentials flow, as that flow will be preformed on every request.

> The OpenFga.SdkClient will by default retry API requests up to 15 times on 429 and 5xx errors.
> The `OpenFga.SdkClient` will by default retry API requests up to 15 times on 429 and 5xx errors.

#### No Credentials

Expand Down
Loading
Loading