Skip to content

Commit

Permalink
chore: update repository templates to ory/meta@939b80f
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Aug 27, 2024
1 parent 9158def commit 0a59fd9
Show file tree
Hide file tree
Showing 8 changed files with 152 additions and 97 deletions.
66 changes: 36 additions & 30 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
@@ -1,43 +1,48 @@
# AUTO-GENERATED, DO NOT EDIT!
# Please edit the original at https://github.com/ory/meta/blob/master/templates/repository/common/.github/ISSUE_TEMPLATE/BUG-REPORT.yml

description: "Create a bug report"
description: 'Create a bug report'
labels:
- bug
name: "Bug Report"
name: 'Bug Report'
body:
- attributes:
value: "Thank you for taking the time to fill out this bug report!\n"
type: markdown
- attributes:
label: "Preflight checklist"
label: 'Preflight checklist'
options:
- label: "I could not find a solution in the existing issues, docs, nor
discussions."
- 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/sdk/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/sdk/blob/master/CONTRIBUTING.md)."
required: true
- label: "I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label: "I am signed up to the [Ory Security Patch
Newsletter](https://www.ory.sh/l/sign-up-newsletter)."
- label:
'I have joined the [Ory Community Slack](https://slack.ory.sh).'
- label:
'I am signed up to the [Ory Security Patch
Newsletter](https://www.ory.sh/l/sign-up-newsletter).'
id: checklist
type: checkboxes
- attributes:
description:
"Enter the slug or API URL of the affected Ory Network project. Leave
empty when you are self-hosting."
label: "Ory Network Project"
placeholder: "https://<your-project-slug>.projects.oryapis.com"
'Enter the slug or API URL of the affected Ory Network project. Leave
empty when you are self-hosting.'
label: 'Ory Network Project'
placeholder: 'https://<your-project-slug>.projects.oryapis.com'
id: ory-network-project
type: input
- attributes:
description: "A clear and concise description of what the bug is."
label: "Describe the bug"
placeholder: "Tell us what you see!"
description: 'A clear and concise description of what the bug is.'
label: 'Describe the bug'
placeholder: 'Tell us what you see!'
id: describe-bug
type: textarea
validations:
Expand All @@ -51,27 +56,28 @@ body:
1. Run `docker run ....`
2. Make API Request to with `curl ...`
3. Request fails with response: `{"some": "error"}`
label: "Reproducing the bug"
label: 'Reproducing the bug'
id: reproduce-bug
type: textarea
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"
redact any sensitive information'
label: 'Relevant log output'
render: shell
placeholder: |
log=error ....
id: logs
type: textarea
- attributes:
description:
"Please copy and paste any relevant configuration. This will be
'Please copy and paste any relevant configuration. This will be
automatically formatted into code, so no need for backticks. Please
redact any sensitive information!"
label: "Relevant configuration"
redact any sensitive information!'
label: 'Relevant configuration'
render: yml
placeholder: |
server:
Expand All @@ -80,14 +86,14 @@ body:
id: config
type: textarea
- attributes:
description: "What version of our software are you running?"
description: 'What version of our software are you running?'
label: Version
id: version
type: input
validations:
required: true
- attributes:
label: "On which operating system are you observing this issue?"
label: 'On which operating system are you observing this issue?'
options:
- Ory Network
- macOS
Expand All @@ -98,19 +104,19 @@ body:
id: operating-system
type: dropdown
- attributes:
label: "In which environment are you deploying?"
label: 'In which environment are you deploying?'
options:
- Ory Network
- Docker
- "Docker Compose"
- "Kubernetes with Helm"
- 'Docker Compose'
- 'Kubernetes with Helm'
- Kubernetes
- Binary
- Other
id: deployment
type: dropdown
- attributes:
description: "Add any other context about the problem here."
description: 'Add any other context about the problem here.'
label: Additional Context
id: additional
type: textarea
48 changes: 27 additions & 21 deletions .github/ISSUE_TEMPLATE/DESIGN-DOC.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# AUTO-GENERATED, DO NOT EDIT!
# Please edit the original at https://github.com/ory/meta/blob/master/templates/repository/common/.github/ISSUE_TEMPLATE/DESIGN-DOC.yml

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"
name: 'Design Document'
body:
- attributes:
value: |
Expand All @@ -20,34 +21,39 @@ body:
after code reviews, and your pull requests will be merged faster.
type: markdown
- attributes:
label: "Preflight checklist"
label: 'Preflight checklist'
options:
- label: "I could not find a solution in the existing issues, docs, nor
discussions."
- 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/sdk/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/sdk/blob/master/CONTRIBUTING.md)."
required: true
- label: "I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label: "I am signed up to the [Ory Security Patch
Newsletter](https://www.ory.sh/l/sign-up-newsletter)."
- label:
'I have joined the [Ory Community Slack](https://slack.ory.sh).'
- label:
'I am signed up to the [Ory Security Patch
Newsletter](https://www.ory.sh/l/sign-up-newsletter).'
id: checklist
type: checkboxes
- attributes:
description:
"Enter the slug or API URL of the affected Ory Network project. Leave
empty when you are self-hosting."
label: "Ory Network Project"
placeholder: "https://<your-project-slug>.projects.oryapis.com"
'Enter the slug or API URL of the affected Ory Network project. Leave
empty when you are self-hosting.'
label: 'Ory Network Project'
placeholder: 'https://<your-project-slug>.projects.oryapis.com'
id: ory-network-project
type: input
- attributes:
description: |
This section gives the reader a very rough overview of the landscape in which the new system is being built and what is actually being built. This isn’t a requirements doc. Keep it succinct! The goal is that readers are brought up to speed but some previous knowledge can be assumed and detailed info can be linked to. This section should be entirely focused on objective background facts.
label: "Context and scope"
label: 'Context and scope'
id: scope
type: textarea
validations:
Expand All @@ -56,7 +62,7 @@ body:
- attributes:
description: |
A short list of bullet points of what the goals of the system are, and, sometimes more importantly, what non-goals are. Note, that non-goals aren’t negated goals like “The system shouldn’t crash”, but rather things that could reasonably be goals, but are explicitly chosen not to be goals. A good example would be “ACID compliance”; when designing a database, you’d certainly want to know whether that is a goal or non-goal. And if it is a non-goal you might still select a solution that provides it, if it doesn’t introduce trade-offs that prevent achieving the goals.
label: "Goals and non-goals"
label: 'Goals and non-goals'
id: goals
type: textarea
validations:
Expand All @@ -68,7 +74,7 @@ body:
The design doc is the place to write down the trade-offs you made in designing your software. Focus on those trade-offs to produce a useful document with long-term value. That is, given the context (facts), goals and non-goals (requirements), the design doc is the place to suggest solutions and show why a particular solution best satisfies those goals.
The point of writing a document over a more formal medium is to provide the flexibility to express the problem at hand in an appropriate manner. Because of this, there is no explicit guidance on how to actually describe the design.
label: "The design"
label: 'The design'
id: design
type: textarea
validations:
Expand All @@ -77,21 +83,21 @@ body:
- attributes:
description: |
If the system under design exposes an API, then sketching out that API is usually a good idea. In most cases, however, one should withstand the temptation to copy-paste formal interface or data definitions into the doc as these are often verbose, contain unnecessary detail and quickly get out of date. Instead, focus on the parts that are relevant to the design and its trade-offs.
label: "APIs"
label: 'APIs'
id: apis
type: textarea

- attributes:
description: |
Systems that store data should likely discuss how and in what rough form this happens. Similar to the advice on APIs, and for the same reasons, copy-pasting complete schema definitions should be avoided. Instead, focus on the parts that are relevant to the design and its trade-offs.
label: "Data storage"
label: 'Data storage'
id: persistence
type: textarea

- attributes:
description: |
Design docs should rarely contain code, or pseudo-code except in situations where novel algorithms are described. As appropriate, link to prototypes that show the feasibility of the design.
label: "Code and pseudo-code"
label: 'Code and pseudo-code'
id: pseudocode
type: textarea

Expand All @@ -104,7 +110,7 @@ body:
On the other end are systems where the possible solutions are very well defined, but it isn't at all obvious how they could even be combined to achieve the goals. This may be a legacy system that is difficult to change and wasn't designed to do what you want it to do or a library design that needs to operate within the constraints of the host programming language.
In this situation, you may be able to enumerate all the things you can do relatively easily, but you need to creatively put those things together to achieve the goals. There may be multiple solutions, and none of them are great, and hence such a document should focus on selecting the best way given all identified trade-offs.
label: "Degree of constraint"
label: 'Degree of constraint'
id: constrait
type: textarea

Expand Down
48 changes: 28 additions & 20 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# AUTO-GENERATED, DO NOT EDIT!
# Please edit the original at https://github.com/ory/meta/blob/master/templates/repository/common/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

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"
name: 'Feature Request'
body:
- attributes:
value: |
Expand All @@ -13,33 +14,39 @@ body:
If you already have a plan to implement a feature or a change, please create a [design document](https://github.com/aeneasr/gh-template-test/issues/new?assignees=&labels=rfc&template=DESIGN-DOC.yml) instead if the change is non-trivial!
type: markdown
- attributes:
label: "Preflight checklist"
label: 'Preflight checklist'
options:
- label: "I could not find a solution in the existing issues, docs, nor
discussions."
- 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/sdk/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/sdk/blob/master/CONTRIBUTING.md)."
required: true
- label: "I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label: "I am signed up to the [Ory Security Patch
Newsletter](https://www.ory.sh/l/sign-up-newsletter)."
- label:
'I have joined the [Ory Community Slack](https://slack.ory.sh).'
- label:
'I am signed up to the [Ory Security Patch
Newsletter](https://www.ory.sh/l/sign-up-newsletter).'
id: checklist
type: checkboxes
- attributes:
description:
"Enter the slug or API URL of the affected Ory Network project. Leave
empty when you are self-hosting."
label: "Ory Network Project"
placeholder: "https://<your-project-slug>.projects.oryapis.com"
'Enter the slug or API URL of the affected Ory Network project. Leave
empty when you are self-hosting.'
label: 'Ory Network Project'
placeholder: 'https://<your-project-slug>.projects.oryapis.com'
id: ory-network-project
type: input
- attributes:
description: "Is your feature request related to a problem? Please describe."
label: "Describe your problem"
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
frustrated when [...]"
Expand All @@ -52,27 +59,28 @@ body:
Describe the solution you'd like
placeholder: |
A clear and concise description of what you want to happen.
label: "Describe your ideal solution"
label: 'Describe your ideal solution'
id: solution
type: textarea
validations:
required: true
- attributes:
description: "Describe alternatives you've considered"
label: "Workarounds or alternatives"
label: 'Workarounds or alternatives'
id: alternatives
type: textarea
validations:
required: true
- attributes:
description: "What version of our software are you running?"
description: 'What version of our software are you running?'
label: Version
id: version
type: input
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
6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ blank_issues_enabled: false
contact_links:
- name: Ory Ory SDK 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.
2 changes: 1 addition & 1 deletion .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
# Please edit the original at https://github.com/ory/meta/blob/master/templates/repository/common/.github/config.yml

todo:
keyword: "@todo"
keyword: '@todo'
label: todo
Loading

0 comments on commit 0a59fd9

Please sign in to comment.