chore: update repository templates to ory/meta@935cc04

ory · Sep 22, 2022 · a3a2423 · a3a2423
1 parent ef3e950
commit a3a2423
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 36 deletions.
diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
@@ -9,18 +9,24 @@ body:
   - attributes:
       label: "Preflight checklist"
       options:
-        - label: "I could not find a solution in the existing issues, docs, nor
+        - label:
+            "I could not find a solution in the existing issues, docs, nor
             discussions."
           required: true
-        - label: "I agree to follow this project's [Code of
+        - label:
+            "I agree to follow this project's [Code of
             Conduct](https://github.com/ory/fosite/blob/master/CODE_OF_CONDUCT.md)."
           required: true
-        - label: "I have read and am following this repository's [Contribution
+        - label:
+            "I have read and am following this repository's [Contribution
             Guidelines](https://github.com/ory/fosite/blob/master/CONTRIBUTING.md)."
           required: true
-        - label: "This issue affects my [Ory Cloud](https://www.ory.sh/) project."
-        - label: "I have joined the [Ory Community Slack](https://slack.ory.sh)."
-        - label: "I am signed up to the [Ory Security Patch
+        - label:
+            "This issue affects my [Ory Cloud](https://www.ory.sh/) project."
+        - label:
+            "I have joined the [Ory Community Slack](https://slack.ory.sh)."
+        - label:
+            "I am signed up to the [Ory Security Patch
             Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)."
     id: checklist
     type: checkboxes
@@ -47,7 +53,8 @@ body:
     validations:
       required: true
   - attributes:
-      description: "Please copy and paste any relevant log output. This will be
+      description:
+        "Please copy and paste any relevant log output. This will be
         automatically formatted into code, so no need for backticks. Please
         redact any sensitive information"
       label: "Relevant log output"

diff --git a/.github/ISSUE_TEMPLATE/DESIGN-DOC.yml b/.github/ISSUE_TEMPLATE/DESIGN-DOC.yml
@@ -1,4 +1,5 @@
-description: "A design document is needed for non-trivial changes to the code base."
+description:
+  "A design document is needed for non-trivial changes to the code base."
 labels:
   - rfc
 name: "Design Document"
@@ -19,18 +20,24 @@ body:
   - attributes:
       label: "Preflight checklist"
       options:
-        - label: "I could not find a solution in the existing issues, docs, nor
+        - label:
+            "I could not find a solution in the existing issues, docs, nor
             discussions."
           required: true
-        - label: "I agree to follow this project's [Code of
+        - label:
+            "I agree to follow this project's [Code of
             Conduct](https://github.com/ory/fosite/blob/master/CODE_OF_CONDUCT.md)."
           required: true
-        - label: "I have read and am following this repository's [Contribution
+        - label:
+            "I have read and am following this repository's [Contribution
             Guidelines](https://github.com/ory/fosite/blob/master/CONTRIBUTING.md)."
           required: true
-        - label: "This issue affects my [Ory Cloud](https://www.ory.sh/) project."
-        - label: "I have joined the [Ory Community Slack](https://slack.ory.sh)."
-        - label: "I am signed up to the [Ory Security Patch
+        - label:
+            "This issue affects my [Ory Cloud](https://www.ory.sh/) project."
+        - label:
+            "I have joined the [Ory Community Slack](https://slack.ory.sh)."
+        - label:
+            "I am signed up to the [Ory Security Patch
             Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)."
     id: checklist
     type: checkboxes

diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
@@ -1,4 +1,5 @@
-description: "Suggest an idea for this project without a plan for implementation"
+description:
+  "Suggest an idea for this project without a plan for implementation"
 labels:
   - feat
 name: "Feature Request"
@@ -12,23 +13,30 @@ body:
   - attributes:
       label: "Preflight checklist"
       options:
-        - label: "I could not find a solution in the existing issues, docs, nor
+        - label:
+            "I could not find a solution in the existing issues, docs, nor
             discussions."
           required: true
-        - label: "I agree to follow this project's [Code of
+        - label:
+            "I agree to follow this project's [Code of
             Conduct](https://github.com/ory/fosite/blob/master/CODE_OF_CONDUCT.md)."
           required: true
-        - label: "I have read and am following this repository's [Contribution
+        - label:
+            "I have read and am following this repository's [Contribution
             Guidelines](https://github.com/ory/fosite/blob/master/CONTRIBUTING.md)."
           required: true
-        - label: "This issue affects my [Ory Cloud](https://www.ory.sh/) project."
-        - label: "I have joined the [Ory Community Slack](https://slack.ory.sh)."
-        - label: "I am signed up to the [Ory Security Patch
+        - label:
+            "This issue affects my [Ory Cloud](https://www.ory.sh/) project."
+        - label:
+            "I have joined the [Ory Community Slack](https://slack.ory.sh)."
+        - label:
+            "I am signed up to the [Ory Security Patch
             Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)."
     id: checklist
     type: checkboxes
   - attributes:
-      description: "Is your feature request related to a problem? Please describe."
+      description:
+        "Is your feature request related to a problem? Please describe."
       label: "Describe your problem"
       placeholder:
         "A clear and concise description of what the problem is. Ex. I'm always
@@ -62,7 +70,8 @@ body:
     validations:
       required: true
   - attributes:
-      description: "Add any other context or screenshots about the feature request here."
+      description:
+        "Add any other context or screenshots about the feature request here."
       label: Additional Context
     id: additional
     type: textarea
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -2,8 +2,10 @@ blank_issues_enabled: false
 contact_links:
   - name: Ory Fosite Forum
     url: https://github.com/orgs/ory/discussions
-    about: Please ask and answer questions here, show your implementations and
+    about:
+      Please ask and answer questions here, show your implementations and
       discuss ideas.
   - name: Ory Chat
     url: https://www.ory.sh/chat
-    about: Hang out with other Ory community members to ask and answer questions.
+    about:
+      Hang out with other Ory community members to ask and answer questions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -37,8 +37,8 @@ them, don't hesitate to ask. We're here to help! This is simply a reminder of wh
 - [ ] I have read the [contributing guidelines](../blob/master/CONTRIBUTING.md) and signed the CLA.
 - [ ] I have referenced an issue containing the design document if my change introduces a new feature.
 - [ ] I have read the [security policy](../security/policy).
-- [ ] I confirm that this pull request does not address a security vulnerability.
-      If this pull request addresses a security vulnerability,
+- [ ] I confirm that this pull request does not address a security vulnerability. 
+      If this pull request addresses a security vulnerability, 
       I confirm that I got green light (please contact [[email protected]](mailto:[email protected])) from the maintainers to push the changes.
 - [ ] I have added tests that prove my fix is effective or that my feature works.
 - [ ] I have added necessary documentation within the code base (if appropriate).

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -178,11 +178,9 @@ request, go through this checklist:
    changes against the `master` branch.
 1. Run the full project test suite with the `go test -tags sqlite ./...` (or
    equivalent) command and confirm that it passes.
-1. Run `make format` if a `Makefile` is available, `gofmt -s` if the project is
-   written in Go, `npm run format` if the project is written for NodeJS.
+1. Run `make format`
 1. Add a descriptive prefix to commits. This ensures a uniform commit history
-   and helps structure the changelog.  
-   Please refer to this
+   and helps structure the changelog. Please refer to this
    [list of prefixes for Fosite](https://github.com/ory/fosite/blob/master/.github/semantic.yml)
    for an overview.
 
@@ -234,11 +232,7 @@ Please disclose vulnerabilities exclusively to
 
 ## Code style
 
-Please follow these guidelines when formatting source code:
-
-- 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.
+Please run `make format` to format all source code following the Ory standard.
 
 ### Working with forks