diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2296eca..b1806a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,7 +48,7 @@ The commit contains the following structural elements, to communicate intent to * BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. -* types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others. +* types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others. * footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format. @@ -66,9 +66,9 @@ When you're ready, submit a pull request! * All changes are required to be [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) Licensed. -* Dependencies & sub dependencies have to have compatible licenses. The existing repositories have [FOSSA checks](https://fossa.com/) integrated as part of their Github Actions CI/CD workflow. New repositories will need to have similar checks in place. +* Dependencies & sub dependencies have to have compatible licenses. The existing repositories have [FOSSA checks](https://fossa.com/) integrated as part of their GitHub Actions CI/CD workflow. New repositories will need to have similar checks in place. -* New contributions have to pass several security tests. The existing repositories have [Snyk](https://snyk.io/) and [Semgrep](https://semgrep.dev/) integrated as part of their Github Actions CI/CD workflow. New repositories will need to have similar checks in place. +* New contributions have to pass several security tests. The existing repositories have [Snyk](https://snyk.io/) and [Semgrep](https://semgrep.dev/) integrated as part of their GitHub Actions CI/CD workflow. New repositories will need to have similar checks in place. * Contributions should introduce minimal to no dependencies. This helps with maintenance as well as security and legal considerations. diff --git a/GOVERNANCE.md b/GOVERNANCE.md index c09987e..57d011a 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -14,7 +14,7 @@ For copyright and trademark information, see [Trademark Usage](https://www.linux ## Roles and Responsibilities -OpenFGA uses a Teams concept to divide up roles and responsibilities. Teams are defined in Github. +OpenFGA uses a Teams concept to divide up roles and responsibilities. Teams are defined in GitHub. ### Teams Currently there are three main teams: @@ -53,13 +53,13 @@ The @product team is concerned with iterating on the product itself. They govern #### Contributors -The @contributors team exists to keep track of and grant certain priveliges to anyone who contributes to the product. +The @contributors team exists to keep track of and grant certain privileges to anyone who contributes to the product. ### Joining a team Anyone can become a member of @contributors team: reach out to anyone on the @core or @product teams via any of the channels in the [Support](#support) section with a request to join and they will make the change. -From there, when someone has a will to be more involved in any of the other teams' responsibilities, and have made significant enough contributions to the product, being promoted to being a member of the @core or @product teams requires making a request and recieving a majority vote from those teams. For more info, see the [Governance-Related Policies and Procedures](#governance-related-policies-and-procedures) section. +From there, when someone has a will to be more involved in any of the other teams' responsibilities, and have made significant enough contributions to the product, being promoted to being a member of the @core or @product teams requires making a request and receiving a majority vote from those teams. For more info, see the [Governance-Related Policies and Procedures](#governance-related-policies-and-procedures) section. ### Leaving a team @@ -89,6 +89,6 @@ We welcome contributions from the broader community! If you would like to contri If you have any questions, feedback, or ideas for OpenFGA, we would love to hear from you. Here are a few ways you can get in touch: -* Join the [OpenFGA Community](https://openfga.dev/community) in the CNCF Slack or [Github Discussions](https://github.com/orgs/openfga/discussions). +* Join the [OpenFGA Community](https://openfga.dev/community) in the CNCF Slack or [GitHub Discussions](https://github.com/orgs/openfga/discussions). - Reach out to us [on Twitter](https://twitter.com/OpenFGA) - Send an email to [contact@openfga.dev](mailto:contact@openfga.dev) diff --git a/SECURITY.md b/SECURITY.md index 4ece8ca..c01b0af 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,6 +2,6 @@ ## Reporting a Vulnerability -Please use this email: security@openfga.dev to reach out to us regarding any security concerns/vulnerabilities. Please avoid using Github issues/discussions for the same. +Please use this email: security@openfga.dev to reach out to us regarding any security concerns/vulnerabilities. Please avoid using GitHub issues/discussions for the same. All vulnerabilities and associated information will be treated with full confidentiality. We strive to reply within 5 business days. diff --git a/profile/README.md b/profile/README.md index 749470a..1e77184 100644 --- a/profile/README.md +++ b/profile/README.md @@ -36,7 +36,7 @@ Centralizing your authorization logic and decisions into a single service that h OpenFGA has high quality developer tooling, including: -- SDKs for [Go](https://github.com/openfga/go-sdk), [Javascript](https://github.com/openfga/js-sdk), [.NET](https://github.com/openfga/dotnet-sdk), [Python](https://github.com/openfga/python-sdk), [Java](https://github.com/openfga/java-sdk). +- SDKs for [Go](https://github.com/openfga/go-sdk), [JavaScript](https://github.com/openfga/js-sdk), [.NET](https://github.com/openfga/dotnet-sdk), [Python](https://github.com/openfga/python-sdk), [Java](https://github.com/openfga/java-sdk). - A [CLI](https://github.com/openfga/cli) to operate an OpenFGA server, import/export models and tuples and test models. - A [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=openfga.openfga-vscode) with syntax coloring and validation for models and tests. - A [Helm Chart](https://github.com/openfga/helm-charts) to simplify deployment in Kubernetes clusters. @@ -47,5 +47,5 @@ OpenFGA has high quality developer tooling, including: * **Contributing**: Read this [CONTRIBUTING.md](https://github.com/openfga/.github/blob/main/CONTRIBUTING.md) guide for an outline for interacting with the OpenFGA community and its governance structure, as well as details how to write, test, and submit code changes. * **Documentation**: Read about OpenFGA at the [project's website and documentation repository, https://openfga.dev](https://openfga.dev). -* **Community**: Join the [OpenFGA Community](https://openfga.dev/community) in the CNCF Slack or [Github Discussions](https://github.com/orgs/openfga/discussions). +* **Community**: Join the [OpenFGA Community](https://openfga.dev/community) in the CNCF Slack or [GitHub Discussions](https://github.com/orgs/openfga/discussions). * **Community Projects**: We're building amazing things with OpenFGA. Check them out in our [Community Projects](https://github.com/openfga/community#community-projects) list. diff --git a/pull_request_template.md b/pull_request_template.md index d51698f..c363184 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -11,7 +11,7 @@ If your PR is under active development, please submit it as a "draft". Once it's ## References - + ## Review Checklist - [ ] I have clicked on ["allow edits by maintainers"](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork).