diff --git a/.github/banner_keto.png b/.github/banner_keto.png deleted file mode 100644 index 40c93df91..000000000 Binary files a/.github/banner_keto.png and /dev/null differ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9bc6472c6..574d87252 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,7 @@ - [Contributing Code](#contributing-code) - [Disclosing vulnerabilities](#disclosing-vulnerabilities) - [Code Style](#code-style) +- [Documentation](#documentation) - [Pull request procedure](#pull-request-procedure) - [Communication](#communication) - [Conduct](#conduct) @@ -55,14 +56,22 @@ should be merged by the submitter after review. ## Disclosing vulnerabilities -Please disclose vulnerabilities exclusively to [hi@ory.am](mailto:hi@ory.am). Do +Please disclose vulnerabilities exclusively to [security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues. ## Code Style Please follow these guidelines when formatting source code: -- Go code should match the output of `gofmt -s` +- Go code should match the output of `gofmt -s` and pass `golangci-lint run`. +- NodeJS and JavaScript code should be prettified using `npm run format` where appropriate. + +## Documentation + +Please provide documentation when changing, removing, or adding features. Documentation +resides in the project's [docs](docs) folder. Some documents are generated using `npm run gen`. + +More information on the docs pipeline can be found in [docs/README.md](docs/README.md). ## Pull request procedure diff --git a/README.md b/README.md index 454170567..f136e6976 100644 --- a/README.md +++ b/README.md @@ -181,6 +181,7 @@ TheCrealm. + ### Installation Head over to the documentation to learn about ways of [installing ORY Keto](https://www.ory.sh/docs/next/keto/install). @@ -236,6 +237,7 @@ to perform a certain action on a resource. + ### Examples The [ory/examples](https://github.com/ory/examples) repository contains numerous examples of setting up this project and combining it with other services from the ORY Ecosystem.