Skip to content

Commit

Permalink
docs: update github templates (#182)
Browse files Browse the repository at this point in the history
Signed-off-by: aeneasr <[email protected]>
  • Loading branch information
aeneasr authored Apr 12, 2020
1 parent c717257 commit 72ea09b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
Binary file removed .github/banner_keto.png
Binary file not shown.
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 72ea09b

Please sign in to comment.