Skip to content

Commit

Permalink
docs: update github templates (#338)
Browse files Browse the repository at this point in the history
Signed-off-by: aeneasr <aeneas@ory.sh>
  • Loading branch information
aeneasr authored Apr 12, 2020
1 parent fe75328 commit 57dbc77
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
Binary file removed .github/banner_kratos.png
Binary file not shown.
19 changes: 11 additions & 8 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 All @@ -88,12 +97,6 @@ Normally, all pull requests must include tests that test your change.
Occasionally, a change will be very difficult to test for. In those cases,
please include a note in your commit message explaining why.

If you've change documentation. Please re-compile this by following these steps:
1. Make sure you have Node installed.
2. `npm install docs/`
3. `node docs/scripts/config.js docs/config.js`
4. Commit all the markdown files with your changes.

## Communication

We use [discord](https://www.ory.sh/chat). You are welcome to drop in and ask
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ TheCrealm.




## Getting Started

To get started, head over to the [ORY Kratos Documentation](https://www.ory.sh/docs/next/kratos).
Expand Down Expand Up @@ -262,6 +263,7 @@ to perform a certain action on a resource.




## Security

Running identity infrastructure requires [attention and knowledge of threat models](https://www.ory.sh/docs/next/kratos/concepts/security).
Expand Down

0 comments on commit 57dbc77

Please sign in to comment.