docs: update github templates (#1795)

Signed-off-by: aeneasr <aeneas@ory.sh>
ory · Apr 12, 2020 · ddbad66 · ddbad66
1 parent e935921
commit ddbad66
Show file tree

Hide file tree

Showing 22 changed files with 13 additions and 1,334 deletions.
diff --git a/.github/images/abstract_flow.png b/.github/images/abstract_flow.png
diff --git a/.github/images/banner_hydra.png b/.github/images/banner_hydra.png
diff --git a/.github/images/consent-flow.svg b/.github/images/consent-flow.svg
diff --git a/.github/images/consent-state.svg b/.github/images/consent-state.svg
diff --git a/.github/images/consent.png b/.github/images/consent.png
diff --git a/.github/images/google.png b/.github/images/google.png
diff --git a/.github/images/google2.png b/.github/images/google2.png
diff --git a/.github/images/hydra-arch-warden.png b/.github/images/hydra-arch-warden.png
diff --git a/.github/images/hydra-authentication.gif b/.github/images/hydra-authentication.gif
diff --git a/.github/images/install-result.png b/.github/images/install-result.png
diff --git a/.github/images/login-success-a.gif b/.github/images/login-success-a.gif
diff --git a/.github/images/logo-essential.png b/.github/images/logo-essential.png
diff --git a/.github/images/logo.png b/.github/images/logo.png
diff --git a/.github/images/oauth2-flow.gif b/.github/images/oauth2-flow.gif
diff --git a/.github/images/oidc-cert.png b/.github/images/oidc-cert.png
diff --git a/.github/images/run-the-example.gif b/.github/images/run-the-example.gif
diff --git a/.github/images/sec-console.png b/.github/images/sec-console.png
diff --git a/.github/images/social-login-example.jpg b/.github/images/social-login-example.jpg
diff --git a/.github/images/social-login-example.png b/.github/images/social-login-example.png
diff --git a/.github/images/social-login.png b/.github/images/social-login.png
diff --git 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
@@ -211,6 +211,7 @@ TheCrealm.
 
 
 
+
 ### OAuth2 and OpenID Connect: Open Standards!
 
 ORY Hydra implements Open Standards set by the IETF:
@@ -321,6 +322,7 @@ to perform a certain action on a resource.
 
 
 
+
 ## Security
 
 *Why should I use ORY Hydra? It's not that hard to implement two OAuth2 endpoints and there are numerous SDKs out there!*