CadolesKube/hydra-maester
7
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

chore: update repository templates

Browse Source 
[skip ci] - updated repository templates to 0206ac3174
This commit is contained in:
aeneasr 2022-06-22 08:10:35 +00:00
parent 1dacbbde7d
commit 1913b56583
11 changed files with 241 additions and 184 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
.github/ISSUE_TEMPLATE/BUG-REPORT.yml vendored
View File

@ -1,17 +1,17 @@
description: 'Create a bug report' description: "Create a bug report"
labels: labels:
- bug - bug
name: 'Bug Report' name: "Bug Report"
body: body:
- attributes: - attributes:
value: "Thank you for taking the time to fill out this bug report!\n" value: "Thank you for taking the time to fill out this bug report!\n"
type: markdown type: markdown
- attributes: - attributes:
label: 'Preflight checklist' label: "Preflight checklist"
options: options:
- label: - label:
'I could not find a solution in the existing issues, docs, nor "I could not find a solution in the existing issues, docs, nor
discussions.' discussions."
required: true required: true
- label: - label:
"I agree to follow this project's [Code of "I agree to follow this project's [Code of
@ -22,18 +22,18 @@ body:
Guidelines](https://github.com/ory/hydra-maester/blob/master/CONTRIBUTING.md)." Guidelines](https://github.com/ory/hydra-maester/blob/master/CONTRIBUTING.md)."
required: true required: true
- label: - label:
'This issue affects my [Ory Cloud](https://www.ory.sh/) project.' "This issue affects my [Ory Cloud](https://www.ory.sh/) project."
- label: - label:
'I have joined the [Ory Community Slack](https://slack.ory.sh).' "I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label: - label:
'I am signed up to the [Ory Security Patch "I am signed up to the [Ory Security Patch
Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53).' Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)."
id: checklist id: checklist
type: checkboxes type: checkboxes
- attributes: - attributes:
description: 'A clear and concise description of what the bug is.' description: "A clear and concise description of what the bug is."
label: 'Describe the bug' label: "Describe the bug"
placeholder: 'Tell us what you see!' placeholder: "Tell us what you see!"
id: describe-bug id: describe-bug
type: textarea type: textarea
validations: validations:
@ -47,17 +47,17 @@ body:
1. Run `docker run ....` 1. Run `docker run ....`
2. Make API Request to with `curl ...` 2. Make API Request to with `curl ...`
3. Request fails with response: `{"some": "error"}` 3. Request fails with response: `{"some": "error"}`
label: 'Reproducing the bug' label: "Reproducing the bug"
id: reproduce-bug id: reproduce-bug
type: textarea type: textarea
validations: validations:
required: true required: true
- attributes: - attributes:
description: description:
'Please copy and paste any relevant log output. This will be "Please copy and paste any relevant log output. This will be
automatically formatted into code, so no need for backticks. Please automatically formatted into code, so no need for backticks. Please
redact any sensitive information' redact any sensitive information"
label: 'Relevant log output' label: "Relevant log output"
render: shell render: shell
placeholder: | placeholder: |
log=error .... log=error ....
@ -65,10 +65,10 @@ body:
type: textarea type: textarea
- attributes: - attributes:
description: 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 automatically formatted into code, so no need for backticks. Please
redact any sensitive information!' redact any sensitive information!"
label: 'Relevant configuration' label: "Relevant configuration"
render: yml render: yml
placeholder: | placeholder: |
server: server:
@ -77,14 +77,14 @@ body:
id: config id: config
type: textarea type: textarea
- attributes: - attributes:
description: 'What version of our software are you running?' description: "What version of our software are you running?"
label: Version label: Version
id: version id: version
type: input type: input
validations: validations:
required: true required: true
- attributes: - attributes:
label: 'On which operating system are you observing this issue?' label: "On which operating system are you observing this issue?"
options: options:
- Ory Cloud - Ory Cloud
- macOS - macOS
@ -95,19 +95,19 @@ body:
id: operating-system id: operating-system
type: dropdown type: dropdown
- attributes: - attributes:
label: 'In which environment are you deploying?' label: "In which environment are you deploying?"
options: options:
- Ory Cloud - Ory Cloud
- Docker - Docker
- 'Docker Compose' - "Docker Compose"
- 'Kubernetes with Helm' - "Kubernetes with Helm"
- Kubernetes - Kubernetes
- Binary - Binary
- Other - Other
id: deployment id: deployment
type: dropdown type: dropdown
- attributes: - attributes:
description: 'Add any other context about the problem here.' description: "Add any other context about the problem here."
label: Additional Context label: Additional Context
id: additional id: additional
type: textarea type: textarea

32
.github/ISSUE_TEMPLATE/DESIGN-DOC.yml vendored
View File

@ -1,8 +1,8 @@
description: description:
'A design document is needed for non-trivial changes to the code base.' "A design document is needed for non-trivial changes to the code base."
labels: labels:
- rfc - rfc
name: 'Design Document' name: "Design Document"
body: body:
- attributes: - attributes:
value: | value: |
@ -18,11 +18,11 @@ body:
after code reviews, and your pull requests will be merged faster. after code reviews, and your pull requests will be merged faster.
type: markdown type: markdown
- attributes: - attributes:
label: 'Preflight checklist' label: "Preflight checklist"
options: options:
- label: - label:
'I could not find a solution in the existing issues, docs, nor "I could not find a solution in the existing issues, docs, nor
discussions.' discussions."
required: true required: true
- label: - label:
"I agree to follow this project's [Code of "I agree to follow this project's [Code of
@ -33,18 +33,18 @@ body:
Guidelines](https://github.com/ory/hydra-maester/blob/master/CONTRIBUTING.md)." Guidelines](https://github.com/ory/hydra-maester/blob/master/CONTRIBUTING.md)."
required: true required: true
- label: - label:
'This issue affects my [Ory Cloud](https://www.ory.sh/) project.' "This issue affects my [Ory Cloud](https://www.ory.sh/) project."
- label: - label:
'I have joined the [Ory Community Slack](https://slack.ory.sh).' "I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label: - label:
'I am signed up to the [Ory Security Patch "I am signed up to the [Ory Security Patch
Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53).' Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)."
id: checklist id: checklist
type: checkboxes type: checkboxes
- attributes: - attributes:
description: | 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. 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 id: scope
type: textarea type: textarea
validations: validations:
@ -53,7 +53,7 @@ body:
- attributes: - attributes:
description: | 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. 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 id: goals
type: textarea type: textarea
validations: validations:
@ -65,7 +65,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 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 set at hand in an appropriate manner. Because of this, there is no explicit guidance for how to actually describe the design. The point of writing a document over a more formal medium is to provide the flexibility to express the problem set at hand in an appropriate manner. Because of this, there is no explicit guidance for how to actually describe the design.
label: 'The design' label: "The design"
id: design id: design
type: textarea type: textarea
validations: validations:
@ -74,21 +74,21 @@ body:
- attributes: - attributes:
description: | 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. 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 id: apis
type: textarea type: textarea
- attributes: - attributes:
description: | 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. 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 id: persistence
type: textarea type: textarea
- attributes: - attributes:
description: | 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 implementability of the design. 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 implementability of the design.
label: 'Code and pseudo-code' label: "Code and pseudo-code"
id: pseudocode id: pseudocode
type: textarea type: textarea
@ -101,7 +101,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. 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 really great, and hence such a document should focus on selecting the best way given all identified trade-offs. 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 really 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 id: constrait
type: textarea type: textarea

30
.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml vendored
View File

@ -1,8 +1,8 @@
description: description:
'Suggest an idea for this project without a plan for implementation' "Suggest an idea for this project without a plan for implementation"
labels: labels:
- feat - feat
name: 'Feature Request' name: "Feature Request"
body: body:
- attributes: - attributes:
value: | value: |
@ -11,11 +11,11 @@ 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! 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 type: markdown
- attributes: - attributes:
label: 'Preflight checklist' label: "Preflight checklist"
options: options:
- label: - label:
'I could not find a solution in the existing issues, docs, nor "I could not find a solution in the existing issues, docs, nor
discussions.' discussions."
required: true required: true
- label: - label:
"I agree to follow this project's [Code of "I agree to follow this project's [Code of
@ -26,18 +26,18 @@ body:
Guidelines](https://github.com/ory/hydra-maester/blob/master/CONTRIBUTING.md)." Guidelines](https://github.com/ory/hydra-maester/blob/master/CONTRIBUTING.md)."
required: true required: true
- label: - label:
'This issue affects my [Ory Cloud](https://www.ory.sh/) project.' "This issue affects my [Ory Cloud](https://www.ory.sh/) project."
- label: - label:
'I have joined the [Ory Community Slack](https://slack.ory.sh).' "I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label: - label:
'I am signed up to the [Ory Security Patch "I am signed up to the [Ory Security Patch
Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53).' Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)."
id: checklist id: checklist
type: checkboxes type: checkboxes
- attributes: - attributes:
description: description:
'Is your feature request related to a problem? Please describe.' "Is your feature request related to a problem? Please describe."
label: 'Describe your problem' label: "Describe your problem"
placeholder: placeholder:
"A clear and concise description of what the problem is. Ex. I'm always "A clear and concise description of what the problem is. Ex. I'm always
frustrated when [...]" frustrated when [...]"
@ -50,20 +50,20 @@ body:
Describe the solution you'd like Describe the solution you'd like
placeholder: | placeholder: |
A clear and concise description of what you want to happen. A clear and concise description of what you want to happen.
label: 'Describe your ideal solution' label: "Describe your ideal solution"
id: solution id: solution
type: textarea type: textarea
validations: validations:
required: true required: true
- attributes: - attributes:
description: "Describe alternatives you've considered" description: "Describe alternatives you've considered"
label: 'Workarounds or alternatives' label: "Workarounds or alternatives"
id: alternatives id: alternatives
type: textarea type: textarea
validations: validations:
required: true required: true
- attributes: - attributes:
description: 'What version of our software are you running?' description: "What version of our software are you running?"
label: Version label: Version
id: version id: version
type: input type: input
@ -71,7 +71,7 @@ body:
required: true required: true
- attributes: - attributes:
description: description:
'Add any other context or screenshots about the feature request here.' "Add any other context or screenshots about the feature request here."
label: Additional Context label: Additional Context
id: additional id: additional
type: textarea type: textarea

2
.github/ISSUE_TEMPLATE/config.yml vendored
View File

@ -1,6 +1,6 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: Ory Ory Oathkeeper Maester Forum - name: Ory Ory Hydra Maester Forum
url: https://github.com/orgs/ory/discussions url: https://github.com/orgs/ory/discussions
about: about:
Please ask and answer questions here, show your implementations and Please ask and answer questions here, show your implementations and

2
.github/config.yml vendored
View File

@ -1,3 +1,3 @@
todo: todo:
keyword: '@todo' keyword: "@todo"
label: todo label: todo

6
.github/pull_request_template.md vendored
View File

@ -37,9 +37,9 @@ 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 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 referenced an issue containing the design document if my change introduces a new feature.
- [ ] I have read the [security policy](../security/policy). - [ ] 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 - [ ] I confirm that this pull request does not address a security vulnerability.
vulnerability, I confirm that I got green light (please contact [security@ory.sh](mailto:security@ory.sh)) from the If this pull request addresses a security vulnerability,
maintainers to push the changes. I confirm that I got green light (please contact [security@ory.sh](mailto:security@ory.sh)) 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 tests that prove my fix is effective or that my feature works.
- [ ] I have added necessary documentation within the code base (if appropriate). - [ ] I have added necessary documentation within the code base (if appropriate).

6
.github/workflows/closed_references.yml vendored
View File

@ -2,13 +2,13 @@ name: Closed Reference Notifier
on: on:
schedule: schedule:
- cron: '0 0 * * *' - cron: "0 0 * * *"
workflow_dispatch: workflow_dispatch:
inputs: inputs:
issueLimit: issueLimit:
description: Max. number of issues to create description: Max. number of issues to create
required: true required: true
default: '5' default: "5"
jobs: jobs:
find_closed_references: find_closed_references:
@ -19,7 +19,7 @@ jobs:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- uses: actions/setup-node@v2-beta - uses: actions/setup-node@v2-beta
with: with:
node-version: '14' node-version: "14"
- uses: ory/closed-reference-notifier@v1 - uses: ory/closed-reference-notifier@v1
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}

10
.github/workflows/stale.yml vendored
View File

@ -1,8 +1,8 @@
name: 'Close Stale Issues' name: "Close Stale Issues"
on: on:
workflow_dispatch: workflow_dispatch:
schedule: schedule:
- cron: '0 0 * * *' - cron: "0 0 * * *"
jobs: jobs:
stale: stale:
@ -35,10 +35,10 @@ jobs:
Thank you for your understanding and to anyone who participated in the conversation! And as written above, please do participate in the conversation if this topic is important to you! Thank you for your understanding and to anyone who participated in the conversation! And as written above, please do participate in the conversation if this topic is important to you!
Thank you 🙏✌️ Thank you 🙏✌️
stale-issue-label: 'stale' stale-issue-label: "stale"
exempt-issue-labels: 'bug,blocking,docs,backlog' exempt-issue-labels: "bug,blocking,docs,backlog"
days-before-stale: 365 days-before-stale: 365
days-before-close: 30 days-before-close: 30
exempt-milestones: true exempt-milestones: true
exempt-assignees: true exempt-assignees: true
only-pr-labels: 'stale' only-pr-labels: "stale"

66
CODE_OF_CONDUCT.md
View File

@ -2,14 +2,17 @@
## Our Pledge ## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation In the interest of fostering an open and welcoming environment, we as
in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, contributors and maintainers pledge to making participation in our project and
sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal our community a harassment-free experience for everyone, regardless of age, body
appearance, race, religion, or sexual identity and orientation. size, disability, ethnicity, sex characteristics, gender identity and
expression, level of experience, education, socio-economic status, nationality,
personal appearance, race, religion, or sexual identity and orientation.
## Our Standards ## Our Standards
Examples of behavior that contributes to creating a positive environment include: Examples of behavior that contributes to creating a positive environment
include:
- Using welcoming and inclusive language - Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences - Being respectful of differing viewpoints and experiences
@ -19,43 +22,56 @@ Examples of behavior that contributes to creating a positive environment include
Examples of unacceptable behavior by participants include: Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances - The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks - Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment - Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission - Publishing others' private information, such as a physical or electronic
- Other conduct which could reasonably be considered inappropriate in a professional setting address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities ## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and Project maintainers are responsible for clarifying the standards of acceptable
fair corrective action in response to any instances of unacceptable behavior. behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and Project maintainers have the right and responsibility to remove, edit, or reject
other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other comments, commits, code, wiki edits, issues, and other contributions that are
behaviors that they deem inappropriate, threatening, offensive, or harmful. not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.
## Scope ## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its This Code of Conduct applies both within project spaces and in public spaces
community. Examples of representing a project or community include using an official project e-mail address, posting via an when an individual is representing the project or its community. Examples of
official social media account, or acting as an appointed representative at an online or offline event. Representation of a project representing a project or community include using an official project e-mail
may be further defined and clarified by project maintainers. address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at Instances of abusive, harassing, or otherwise unacceptable behavior may be
office@ory.sh. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and reported by contacting the project team at office@ory.sh. All complaints will be
appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an reviewed and investigated and will result in a response that is deemed necessary
incident. Further details of specific enforcement policies may be posted separately. and appropriate to the circumstances. The project team is obligated to maintain
confidentiality with regard to the reporter of an incident. Further details of
specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions Project maintainers who do not follow or enforce the Code of Conduct in good
as determined by other members of the project's leadership. faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution ## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org [homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

210
CONTRIBUTING.md
View File

@ -8,7 +8,7 @@ https://github.com/ory/meta/blob/master/templates/repository/common/CONTRIBUTING
--> -->
# Contributing to Ory Ory Oathkeeper Maester # Contributing to Ory Ory Hydra Maester
<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@ -28,44 +28,52 @@ https://github.com/ory/meta/blob/master/templates/repository/common/CONTRIBUTING
## Introduction ## Introduction
There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level There are many ways in which you can contribute, beyond writing code. The goal
overview of how you can get involved. of this document is to provide a high-level overview of how you can get
involved.
_Please note_: We take Ory Ory Oathkeeper Maester's security and our users' trust very seriously. If you believe you have found a security issue _Please note_: We take Ory Ory Hydra Maester's security and our users' trust very
in Ory Ory Oathkeeper Maester, please responsibly disclose by contacting us at security@ory.sh. seriously. If you believe you have found a security issue in Ory Ory Hydra Maester,
please responsibly disclose by contacting us at security@ory.sh.
First: As a potential contributor, your changes and ideas are welcome at any hour of the day or night, weekdays, weekends, and First: As a potential contributor, your changes and ideas are welcome at any
holidays. Please do not ever hesitate to ask a question or send a pull request. hour of the day or night, weekdays, weekends, and holidays. Please do not ever
hesitate to ask a question or send a pull request.
If you are unsure, just ask or submit the issue or pull request anyways. You won't be yelled at for giving it your best effort. If you are unsure, just ask or submit the issue or pull request anyways. You
The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't won't be yelled at for giving it your best effort. The worst that can happen is
want a wall of rules to get in the way of that. that you'll be politely asked to change something. We appreciate any sort of
contributions, and don't want a wall of rules to get in the way of that.
That said, if you want to ensure that a pull request is likely to be merged, talk to us! You can find out our thoughts and ensure That said, if you want to ensure that a pull request is likely to be merged,
that your contribution won't clash or be obviated by Ory talk to us! You can find out our thoughts and ensure that your contribution
Ory Oathkeeper Maester's normal direction. A great way to won't clash or be obviated by Ory
Ory Hydra Maester's normal direction. A great way to
do this is via do this is via
[Ory Ory Oathkeeper Maester Discussions](https://github.com/orgs/ory/discussions) or the [Ory Ory Hydra Maester Discussions](https://github.com/orgs/ory/discussions)
[Ory Chat](https://www.ory.sh/chat). or the [Ory Chat](https://www.ory.sh/chat).
## FAQ ## FAQ
- I am new to the community. Where can I find the - I am new to the community. Where can I find the
[Ory Community Code of Conduct?](https://github.com/ory/hydra-maester/blob/master/CODE_OF_CONDUCT.md) [Ory Community Code of Conduct?](https://github.com/ory/hydra-maester/blob/master/CODE_OF_CONDUCT.md)
- I have a question. Where can I get [answers to questions regarding Ory Ory Oathkeeper Maester?](#communication) - I have a question. Where can I get
[answers to questions regarding Ory Ory Hydra Maester?](#communication)
- I would like to contribute but I am not sure how. Are there [easy ways to contribute?](#how-can-i-contribute) - I would like to contribute but I am not sure how. Are there
[easy ways to contribute?](#how-can-i-contribute)
[Or good first issues?](https://github.com/search?l=&o=desc&q=label%3A%22help+wanted%22+label%3A%22good+first+issue%22+is%3Aopen+user%3Aory+user%3Aory-corp&s=updated&type=Issues) [Or good first issues?](https://github.com/search?l=&o=desc&q=label%3A%22help+wanted%22+label%3A%22good+first+issue%22+is%3Aopen+user%3Aory+user%3Aory-corp&s=updated&type=Issues)
- I want to talk to other Ory Ory Oathkeeper Maester users. [How can I become a part of the community?](#communication) - I want to talk to other Ory Ory Hydra Maester users.
[How can I become a part of the community?](#communication)
- I would like to know what I am agreeing to when I contribute to Ory - I would like to know what I am agreeing to when I contribute to Ory
Ory Oathkeeper Maester. Ory Hydra Maester.
Does Ory have Does Ory have
[a Contributors License Agreement?](https://cla-assistant.io/ory/hydra-maester) [a Contributors License Agreement?](https://cla-assistant.io/ory/hydra-maester)
- I would like updates about new versions of Ory Ory Oathkeeper Maester. - I would like updates about new versions of Ory Ory Hydra Maester.
[How are new releases announced?](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53) [How are new releases announced?](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)
## How can I contribute? ## How can I contribute?
@ -73,63 +81,80 @@ do this is via
If you want to start contributing code right away, we have a If you want to start contributing code right away, we have a
[list of good first issues](https://github.com/ory/hydra-maester/labels/good%20first%20issue). [list of good first issues](https://github.com/ory/hydra-maester/labels/good%20first%20issue).
There are many other ways you can contribute without writing any code. Here are a few things you can do to help out: There are many other ways you can contribute without writing any code. Here are
a few things you can do to help out:
- **Give us a star.** It may not seem like much, but it really makes a difference. This is something that everyone can do to help - **Give us a star.** It may not seem like much, but it really makes a
out Ory Ory Oathkeeper Maester. Github stars help the project gain visibility and stand out. difference. This is something that everyone can do to help out Ory Ory Hydra Maester.
Github stars help the project gain visibility and stand out.
- **Join the community.** Sometimes helping people can be as easy as listening to their problems and offering a different - **Join the community.** Sometimes helping people can be as easy as listening
perspective. Join our Slack, have a look at discussions in the forum and take part in our weekly hangout. More info on this in to their problems and offering a different perspective. Join our Slack, have a
[Communication](#communication). look at discussions in the forum and take part in our weekly hangout. More
info on this in [Communication](#communication).
- **Helping with open issues.** We have a lot of open issues for Ory Ory Oathkeeper Maester and some of them may lack necessary information, - **Helping with open issues.** We have a lot of open issues for Ory Ory Hydra Maester
some are duplicates of older issues. You can help out by guiding people through the process of filling out the issue template, and some of them may lack necessary information, some are duplicates of older
asking for clarifying information, or pointing them to existing issues that match their description of the problem. issues. You can help out by guiding people through the process of filling out
the issue template, asking for clarifying information, or pointing them to
existing issues that match their description of the problem.
- **Reviewing documentation changes.** Most documentation just needs a review for proper spelling and grammar. If you think a - **Reviewing documentation changes.** Most documentation just needs a review
document can be improved in any way, feel free to hit the `edit` button at the top of the page. More info on contributing to for proper spelling and grammar. If you think a document can be improved in
documentation [here](#documentation). any way, feel free to hit the `edit` button at the top of the page. More info
on contributing to documentation [here](#documentation).
- **Help with tests.** Some pull requests may lack proper tests or test plans. These are needed for the change to be implemented - **Help with tests.** Some pull requests may lack proper tests or test plans.
safely. These are needed for the change to be implemented safely.
## Communication ## Communication
We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask questions, discuss bugs and feature requests, talk to We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask
other users of Ory, etc. questions, discuss bugs and feature requests, talk to other users of Ory, etc.
Check out [Ory Ory Oathkeeper Maester Discussions](https://github.com/orgs/ory/discussions). This is a great place for in-depth discussions and lots of code examples, logs Check out [Ory Ory Hydra Maester Discussions](https://github.com/orgs/ory/discussions). This is a great place for
and similar data. in-depth discussions and lots of code examples, logs and similar data.
You can also join our community hangout, if you want to speak to the Ory team directly or ask some questions. You can find more You can also join our community hangout, if you want to speak to the Ory team
info on the hangouts in [Slack](https://www.ory.sh/chat). directly or ask some questions. You can find more info on the hangouts in
[Slack](https://www.ory.sh/chat).
If you want to receive regular notifications about updates to Ory Ory Oathkeeper Maester, consider joining the mailing list. We will _only_ send If you want to receive regular notifications about updates to Ory Ory Hydra Maester,
you vital information on the projects that you are interested in. consider joining the mailing list. We will _only_ send you vital information on
the projects that you are interested in.
Also [follow us on twitter](https://twitter.com/orycorp). Also [follow us on twitter](https://twitter.com/orycorp).
## Contributing Code ## Contributing Code
Unless you are fixing a known bug, we **strongly** recommend discussing it with the core team via a GitHub issue or Unless you are fixing a known bug, we **strongly** recommend discussing it with
[in our chat](https://www.ory.sh/chat) before getting started to ensure your work is consistent with Ory Ory Oathkeeper Maester's roadmap and the core team via a GitHub issue or [in our chat](https://www.ory.sh/chat)
architecture. before getting started to ensure your work is consistent with Ory Ory Hydra Maester's
roadmap and architecture.
All contributions are made via pull requests. To make a pull request, you will need a GitHub account; if you are unclear on this All contributions are made via pull requests. To make a pull request, you will
process, see GitHub's documentation on [forking](https://help.github.com/articles/fork-a-repo) and need a GitHub account; if you are unclear on this process, see GitHub's
[pull requests](https://help.github.com/articles/using-pull-requests). Pull requests should be targeted at the `master` branch. documentation on [forking](https://help.github.com/articles/fork-a-repo) and
Before creating a pull request, go through this checklist: [pull requests](https://help.github.com/articles/using-pull-requests). Pull
requests should be targeted at the `master` branch. Before creating a pull
request, go through this checklist:
1. Create a feature branch off of `master` so that changes do not get mixed up. 1. Create a feature branch off of `master` so that changes do not get mixed up.
1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local changes against the `master` branch. 1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local
1. Run the full project test suite with the `go test -tags sqlite ./...` (or equivalent) command and confirm that it passes. changes against the `master` branch.
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 1. Run the full project test suite with the `go test -tags sqlite ./...` (or
written for NodeJS. equivalent) command and confirm that it passes.
1. Ensure that each commit has a descriptive prefix. This ensures a uniform commit history and helps structure the changelog. 1. Run `make format` if a `Makefile` is available, `gofmt -s` if the project is
Please refer to this [list of prefixes for Ory Oathkeeper Maester](https://github.com/ory/hydra-maester/blob/master/.github/semantic.yml) for an written in Go, `npm run format` if the project is written for NodeJS.
overview. 1. Ensure that each commit has a descriptive prefix. This ensures a uniform
1. Sign-up with CircleCI so that it has access to your repository with the branch containing your PR. Simply creating a CircleCI commit history and helps structure the changelog.
account is sufficient for the CI jobs to run, you do not need to setup a CircleCI project for the branch. Please refer to this
[list of prefixes for Ory Hydra Maester](https://github.com/ory/hydra-maester/blob/master/.github/semantic.yml)
for an overview.
1. Sign-up with CircleCI so that it has access to your repository with the
branch containing your PR. Simply creating a CircleCI account is sufficient
for the CI jobs to run, you do not need to setup a CircleCI project for the
branch.
If a pull request is not ready to be reviewed yet If a pull request is not ready to be reviewed yet
[it should be marked as a "Draft"](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request). [it should be marked as a "Draft"](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).
@ -137,46 +162,55 @@ If a pull request is not ready to be reviewed yet
Before your contributions can be reviewed you need to sign our Before your contributions can be reviewed you need to sign our
[Contributor License Agreement](https://cla-assistant.io/ory/hydra-maester). [Contributor License Agreement](https://cla-assistant.io/ory/hydra-maester).
This agreement defines the terms under which your code is contributed to Ory. More specifically it declares that you have the This agreement defines the terms under which your code is contributed to Ory.
right to, and actually do, grant us the rights to use your contribution. You can see the Apache 2.0 license under which our More specifically it declares that you have the right to, and actually do, grant
projects are published [here](https://github.com/ory/meta/blob/master/LICENSE). us the rights to use your contribution. You can see the Apache 2.0 license under
which our projects are published
[here](https://github.com/ory/meta/blob/master/LICENSE).
When pull requests fail testing, authors are expected to update their pull requests to address the failures until the tests pass. When pull requests fail testing, authors are expected to update their pull
requests to address the failures until the tests pass.
Pull requests eligible for review Pull requests eligible for review
1. follow the repository's code formatting conventions; 1. follow the repository's code formatting conventions;
2. include tests which prove that the change works as intended and does not add regressions; 2. include tests which prove that the change works as intended and does not add
regressions;
3. document the changes in the code and/or the project's documentation; 3. document the changes in the code and/or the project's documentation;
4. pass the CI pipeline; 4. pass the CI pipeline;
5. have signed our [Contributor License Agreement](https://cla-assistant.io/ory/hydra-maester); 5. have signed our
[Contributor License Agreement](https://cla-assistant.io/ory/hydra-maester);
6. include a proper git commit message following the 6. include a proper git commit message following the
[Conventional Commit Specification](https://www.conventionalcommits.org/en/v1.0.0/). [Conventional Commit Specification](https://www.conventionalcommits.org/en/v1.0.0/).
If all of these items are checked, the pull request is ready to be reviewed and you should change the status to "Ready for review" If all of these items are checked, the pull request is ready to be reviewed and
and you should change the status to "Ready for review" and
[request review from a maintainer](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review). [request review from a maintainer](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).
Reviewers will approve the pull request once they are satisfied with the patch. Reviewers will approve the pull request once they are satisfied with the patch.
## Documentation ## Documentation
Please provide documentation when changing, removing, or adding features. Documentation resides in the project's Please provide documentation when changing, removing, or adding features.
[docs](https://github.com/ory/hydra-maester/tree/master/docs) folder. Generate API and configuration reference documentation using Documentation resides in the project's
`cd docs; npm run gen`. [docs](https://github.com/ory/hydra-maester/tree/master/docs) folder. Generate API and
configuration reference documentation using `cd docs; npm run gen`.
For further instructions please head over to [docs/README.md](https://github.com/ory/hydra-maester/blob/master/README.md). For further instructions please head over to
[docs/README.md](https://github.com/ory/hydra-maester/blob/master/README.md).
## Disclosing vulnerabilities ## Disclosing vulnerabilities
Please disclose vulnerabilities exclusively to [security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues. Please disclose vulnerabilities exclusively to
[security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues.
## Code Style ## Code Style
Please follow these guidelines when formatting source code: Please follow these guidelines when formatting source code:
- Go code should match the output of `gofmt -s` and pass `golangci-lint run`. - 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. - NodeJS and JavaScript code should be prettified using `npm run format` where
appropriate.
### Working with Forks ### Working with Forks
@ -207,19 +241,25 @@ Now go to the project's GitHub Pull Request page and click "New pull request"
## Conduct ## Conduct
Whether you are a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your Whether you are a regular contributor or a newcomer, we care about making this
back. community a safe place for you and we've got your back.
- We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, - We are committed to providing a friendly, safe and welcoming environment for
disability, ethnicity, religion, or similar personal characteristic. all, regardless of gender, sexual orientation, disability, ethnicity,
- Please avoid using nicknames that might detract from a friendly, safe and welcoming environment for all. religion, or similar personal characteristic.
- Please avoid using nicknames that might detract from a friendly, safe and
welcoming environment for all.
- Be kind and courteous. There is no need to be mean or rude. - Be kind and courteous. There is no need to be mean or rude.
- We will exclude you from interaction if you insult, demean or harass anyone. In particular, we do not tolerate behavior that - We will exclude you from interaction if you insult, demean or harass anyone.
excludes people in socially marginalized groups. In particular, we do not tolerate behavior that excludes people in socially
- Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made marginalized groups.
uncomfortable by a community member, please contact one of the channel ops or a member of the Ory Ory Oathkeeper Maester core team - Private harassment is also unacceptable. No matter who you are, if you feel
immediately. you have been or are being harassed or made uncomfortable by a community
- Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome. member, please contact one of the channel ops or a member of the Ory Ory Hydra Maester
core team immediately.
- Likewise any spamming, trolling, flaming, baiting or other attention-stealing
behaviour is not welcome.
We welcome discussion about creating a welcoming, safe, and productive environment for the community. If you have any questions, We welcome discussion about creating a welcoming, safe, and productive
feedback, or concerns [please let us know](https://www.ory.sh/chat). environment for the community. If you have any questions, feedback, or concerns
[please let us know](https://www.ory.sh/chat).

11
SECURITY.md
View File

@ -21,8 +21,8 @@ https://github.com/ory/meta/blob/master/templates/repository/SECURITY.md
## Supported Versions ## Supported Versions
We release patches for security vulnerabilities. Which versions are eligible receiving such patches depend on the CVSS v3.0 We release patches for security vulnerabilities. Which versions are eligible
Rating: receiving such patches depend on the CVSS v3.0 Rating:
| CVSS v3.0 | Supported Versions | | CVSS v3.0 | Supported Versions |
| --------- | ----------------------------------------- | | --------- | ----------------------------------------- |
@ -31,6 +31,7 @@ Rating:
## Reporting a Vulnerability ## Reporting a Vulnerability
Please report (suspected) security vulnerabilities to **[security@ory.sh](mailto:security@ory.sh)**. You will receive a response Please report (suspected) security vulnerabilities to
from us within 48 hours. If the issue is confirmed, we will release a patch as soon as possible depending on complexity but **[security@ory.sh](mailto:security@ory.sh)**. You will receive a response from
historically within a few days. us within 48 hours. If the issue is confirmed, we will release a patch as soon
as possible depending on complexity but historically within a few days.