chore: update repository templates
[skip ci] - updated repository templates to b7308052ea
This commit is contained in:
parent
4118d8dd48
commit
399088f052
4
.github/ISSUE_TEMPLATE/config.yml
vendored
4
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,7 +1,7 @@
|
|||||||
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/ory/hydra-maester/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
|
||||||
discuss ideas.
|
discuss ideas.
|
||||||
|
20
.github/pull_request_template.md
vendored
20
.github/pull_request_template.md
vendored
@ -34,20 +34,14 @@ Put an `x` in the boxes that apply. You can also fill these out after creating t
|
|||||||
them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
|
them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
- [ ] I have read the [contributing guidelines](../blob/master/CONTRIBUTING.md)
|
- [ ] I have read the [contributing guidelines](../blob/master/CONTRIBUTING.md) and signed the CLA.
|
||||||
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
|
- [ ] I confirm that this pull request does not address a security vulnerability. If this pull request addresses a security
|
||||||
vulnerability. If this pull request addresses a security vulnerability, I
|
vulnerability, I confirm that I got green light (please contact [security@ory.sh](mailto:security@ory.sh)) from the
|
||||||
confirm that I got green light (please contact
|
maintainers to push the changes.
|
||||||
[security@ory.sh](mailto:security@ory.sh)) from the maintainers to push
|
- [ ] I have added tests that prove my fix is effective or that my feature works.
|
||||||
the changes.
|
- [ ] I have added necessary documentation within the code base (if appropriate).
|
||||||
- [ ] 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).
|
|
||||||
|
|
||||||
## Further comments
|
## Further comments
|
||||||
|
|
||||||
|
@ -2,17 +2,14 @@
|
|||||||
|
|
||||||
## Our Pledge
|
## Our Pledge
|
||||||
|
|
||||||
In the interest of fostering an open and welcoming environment, we as
|
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation
|
||||||
contributors and maintainers pledge to making participation in our project and
|
in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity,
|
||||||
our community a harassment-free experience for everyone, regardless of age, body
|
sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal
|
||||||
size, disability, ethnicity, sex characteristics, gender identity and
|
appearance, race, religion, or sexual identity and orientation.
|
||||||
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
|
Examples of behavior that contributes to creating a positive environment include:
|
||||||
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
|
||||||
@ -22,56 +19,43 @@ 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
|
- The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||||
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
|
- Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||||
address, without explicit permission
|
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||||
- 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
|
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and
|
||||||
behavior and are expected to take appropriate and fair corrective action in
|
fair corrective action in response to any instances of unacceptable behavior.
|
||||||
response to any instances of unacceptable behavior.
|
|
||||||
|
|
||||||
Project maintainers have the right and responsibility to remove, edit, or reject
|
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and
|
||||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other
|
||||||
not aligned to this Code of Conduct, or to ban temporarily or permanently any
|
behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
||||||
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
|
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its
|
||||||
when an individual is representing the project or its community. Examples of
|
community. Examples of representing a project or community include using an official project e-mail address, posting via an
|
||||||
representing a project or community include using an official project e-mail
|
official social media account, or acting as an appointed representative at an online or offline event. Representation of a project
|
||||||
address, posting via an official social media account, or acting as an appointed
|
may be further defined and clarified by project maintainers.
|
||||||
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
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
|
||||||
reported by contacting the project team at office@ory.sh. All complaints will be
|
office@ory.sh. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and
|
||||||
reviewed and investigated and will result in a response that is deemed necessary
|
appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an
|
||||||
and appropriate to the circumstances. The project team is obligated to maintain
|
incident. Further details of specific enforcement policies may be posted separately.
|
||||||
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
|
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions
|
||||||
faith may face temporary or permanent repercussions as determined by other
|
as determined by other members of the project's leadership.
|
||||||
members of the project's leadership.
|
|
||||||
|
|
||||||
## Attribution
|
## Attribution
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
|
||||||
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
|
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
|
||||||
https://www.contributor-covenant.org/faq
|
|
||||||
|
210
CONTRIBUTING.md
210
CONTRIBUTING.md
@ -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,52 +28,44 @@ 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
|
There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level
|
||||||
of this document is to provide a high-level overview of how you can get
|
overview of how you can get involved.
|
||||||
involved.
|
|
||||||
|
|
||||||
_Please note_: We take Ory Ory Oathkeeper Maester's security and our users' trust very
|
_Please note_: We take Ory Ory Hydra Maester's security and our users' trust very seriously. If you believe you have found a security issue
|
||||||
seriously. If you believe you have found a security issue in Ory Ory Oathkeeper Maester,
|
in Ory Ory Hydra Maester, please responsibly disclose by contacting us at security@ory.sh.
|
||||||
please responsibly disclose by contacting us at security@ory.sh.
|
|
||||||
|
|
||||||
First: As a potential contributor, your changes and ideas are welcome at any
|
First: As a potential contributor, your changes and ideas are welcome at any hour of the day or night, weekdays, weekends, and
|
||||||
hour of the day or night, weekdays, weekends, and holidays. Please do not ever
|
holidays. Please do not ever hesitate to ask a question or send a pull request.
|
||||||
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
|
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.
|
||||||
won't be yelled at for giving it your best effort. The worst that can happen is
|
The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't
|
||||||
that you'll be politely asked to change something. We appreciate any sort of
|
want a wall of rules to get in the way of that.
|
||||||
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,
|
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
|
||||||
talk to us! You can find out our thoughts and ensure that your contribution
|
that your contribution won't clash or be obviated by Ory
|
||||||
won't clash or be obviated by Ory
|
Ory Hydra Maester's normal direction. A great way to
|
||||||
Ory Oathkeeper 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)
|
[Ory Ory Hydra Maester Discussions](https://github.com/orgs/ory/discussions) or the
|
||||||
or the [Ory Chat](https://www.ory.sh/chat).
|
[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
|
- I have a question. Where can I get [answers to questions regarding Ory Ory Hydra Maester?](#communication)
|
||||||
[answers to questions regarding Ory Ory Oathkeeper Maester?](#communication)
|
|
||||||
|
|
||||||
- I would like to contribute but I am not sure how. Are there
|
- I would like to contribute but I am not sure how. Are there [easy ways to contribute?](#how-can-i-contribute)
|
||||||
[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.
|
- I want to talk to other Ory Ory Hydra Maester users. [How can I become a part of the community?](#communication)
|
||||||
[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?
|
||||||
@ -81,80 +73,63 @@ or the [Ory Chat](https://www.ory.sh/chat).
|
|||||||
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
|
There are many other ways you can contribute without writing any code. Here are a few things you can do to help out:
|
||||||
a few things you can do to help out:
|
|
||||||
|
|
||||||
- **Give us a star.** It may not seem like much, but it really makes a
|
- **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
|
||||||
difference. This is something that everyone can do to help out Ory Ory Oathkeeper Maester.
|
out Ory Ory Hydra Maester. Github stars help the project gain visibility and stand out.
|
||||||
Github stars help the project gain visibility and stand out.
|
|
||||||
|
|
||||||
- **Join the community.** Sometimes helping people can be as easy as listening
|
- **Join the community.** Sometimes helping people can be as easy as listening to their problems and offering a different
|
||||||
to their problems and offering a different perspective. Join our Slack, have a
|
perspective. Join our Slack, have a look at discussions in the forum and take part in our weekly hangout. More info on this in
|
||||||
look at discussions in the forum and take part in our weekly hangout. More
|
[Communication](#communication).
|
||||||
info on this in [Communication](#communication).
|
|
||||||
|
|
||||||
- **Helping with open issues.** We have a lot of open issues for Ory Ory Oathkeeper Maester
|
- **Helping with open issues.** We have a lot of open issues for Ory Ory Hydra Maester and some of them may lack necessary information,
|
||||||
and some of them may lack necessary information, some are duplicates of older
|
some are duplicates of older issues. You can help out by guiding people through the process of filling out the issue template,
|
||||||
issues. You can help out by guiding people through the process of filling out
|
asking for clarifying information, or pointing them to existing issues that match their description of the problem.
|
||||||
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
|
- **Reviewing documentation changes.** Most documentation just needs a review for proper spelling and grammar. If you think a
|
||||||
for proper spelling and grammar. If you think a document can be improved in
|
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
|
||||||
any way, feel free to hit the `edit` button at the top of the page. More info
|
documentation [here](#documentation).
|
||||||
on contributing to documentation [here](#documentation).
|
|
||||||
|
|
||||||
- **Help with tests.** Some pull requests may lack proper tests or test plans.
|
- **Help with tests.** Some pull requests may lack proper tests or test plans. These are needed for the change to be implemented
|
||||||
These are needed for the change to be implemented safely.
|
safely.
|
||||||
|
|
||||||
## Communication
|
## Communication
|
||||||
|
|
||||||
We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask
|
We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask questions, discuss bugs and feature requests, talk to
|
||||||
questions, discuss bugs and feature requests, talk to other users of Ory, etc.
|
other users of Ory, etc.
|
||||||
|
|
||||||
Check out [Ory Ory Oathkeeper Maester Discussions](https://github.com/orgs/ory/discussions). This is a great place for
|
Check out [Ory Ory Hydra Maester Discussions](https://github.com/orgs/ory/discussions). This is a great place for in-depth discussions and lots of code examples, logs
|
||||||
in-depth discussions and lots of code examples, logs and similar data.
|
and similar data.
|
||||||
|
|
||||||
You can also join our community hangout, if you want to speak to the Ory team
|
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
|
||||||
directly or ask some questions. You can find more info on the hangouts in
|
info on the hangouts in [Slack](https://www.ory.sh/chat).
|
||||||
[Slack](https://www.ory.sh/chat).
|
|
||||||
|
|
||||||
If you want to receive regular notifications about updates to Ory Ory Oathkeeper Maester,
|
If you want to receive regular notifications about updates to Ory Ory Hydra Maester, consider joining the mailing list. We will _only_ send
|
||||||
consider joining the mailing list. We will _only_ send you vital information on
|
you vital information on the projects that you are interested in.
|
||||||
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
|
Unless you are fixing a known bug, we **strongly** recommend discussing it with the core team via a GitHub issue or
|
||||||
the core team via a GitHub issue or [in our chat](https://www.ory.sh/chat)
|
[in our chat](https://www.ory.sh/chat) before getting started to ensure your work is consistent with Ory Ory Hydra Maester's roadmap and
|
||||||
before getting started to ensure your work is consistent with Ory Ory Oathkeeper Maester's
|
architecture.
|
||||||
roadmap and architecture.
|
|
||||||
|
|
||||||
All contributions are made via pull requests. To make a pull request, you will
|
All contributions are made via pull requests. To make a pull request, you will need a GitHub account; if you are unclear on this
|
||||||
need a GitHub account; if you are unclear on this process, see GitHub's
|
process, see GitHub's documentation on [forking](https://help.github.com/articles/fork-a-repo) and
|
||||||
documentation on [forking](https://help.github.com/articles/fork-a-repo) and
|
[pull requests](https://help.github.com/articles/using-pull-requests). Pull requests should be targeted at the `master` branch.
|
||||||
[pull requests](https://help.github.com/articles/using-pull-requests). Pull
|
Before creating a pull request, go through this checklist:
|
||||||
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
|
1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local changes against the `master` branch.
|
||||||
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 the full project test suite with the `go test -tags sqlite ./...` (or
|
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
|
||||||
equivalent) command and confirm that it passes.
|
written for NodeJS.
|
||||||
1. Run `make format` if a `Makefile` is available, `gofmt -s` if the project is
|
1. Ensure that each commit has a descriptive prefix. This ensures a uniform commit history and helps structure the changelog.
|
||||||
written in Go, `npm run format` if the project is written for NodeJS.
|
Please refer to this [list of prefixes for Ory Hydra Maester](https://github.com/ory/hydra-maester/blob/master/.github/semantic.yml) for an
|
||||||
1. Ensure that each commit has a descriptive prefix. This ensures a uniform
|
overview.
|
||||||
commit history and helps structure the changelog.
|
1. Sign-up with CircleCI so that it has access to your repository with the branch containing your PR. Simply creating a CircleCI
|
||||||
Please refer to this
|
account is sufficient for the CI jobs to run, you do not need to setup a CircleCI project for the branch.
|
||||||
[list of prefixes for Ory Oathkeeper 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).
|
||||||
@ -162,55 +137,46 @@ 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.
|
This agreement defines the terms under which your code is contributed to Ory. More specifically it declares that you have the
|
||||||
More specifically it declares that you have the right to, and actually do, grant
|
right to, and actually do, grant us the rights to use your contribution. You can see the Apache 2.0 license under which our
|
||||||
us the rights to use your contribution. You can see the Apache 2.0 license under
|
projects are published [here](https://github.com/ory/meta/blob/master/LICENSE).
|
||||||
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
|
When pull requests fail testing, authors are expected to update their pull requests to address the failures until the tests pass.
|
||||||
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
|
2. include tests which prove that the change works as intended and does not add regressions;
|
||||||
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
|
5. have signed our [Contributor License Agreement](https://cla-assistant.io/ory/hydra-maester);
|
||||||
[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
|
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"
|
||||||
you should change the status to "Ready for review" and
|
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.
|
Please provide documentation when changing, removing, or adding features. Documentation resides in the project's
|
||||||
Documentation resides in the project's
|
[docs](https://github.com/ory/hydra-maester/tree/master/docs) folder. Generate API and configuration reference documentation using
|
||||||
[docs](https://github.com/ory/hydra-maester/tree/master/docs) folder. Generate API and
|
`cd docs; npm run gen`.
|
||||||
configuration reference documentation using `cd docs; npm run gen`.
|
|
||||||
|
|
||||||
For further instructions please head over to
|
For further instructions please head over to [docs/README.md](https://github.com/ory/hydra-maester/blob/master/README.md).
|
||||||
[docs/README.md](https://github.com/ory/hydra-maester/blob/master/README.md).
|
|
||||||
|
|
||||||
## Disclosing vulnerabilities
|
## Disclosing vulnerabilities
|
||||||
|
|
||||||
Please disclose vulnerabilities exclusively to
|
Please disclose vulnerabilities exclusively to [security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues.
|
||||||
[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
|
- NodeJS and JavaScript code should be prettified using `npm run format` where appropriate.
|
||||||
appropriate.
|
|
||||||
|
|
||||||
### Working with Forks
|
### Working with Forks
|
||||||
|
|
||||||
@ -241,25 +207,19 @@ 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
|
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
|
||||||
community a safe place for you and we've got your back.
|
back.
|
||||||
|
|
||||||
- We are committed to providing a friendly, safe and welcoming environment for
|
- We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation,
|
||||||
all, regardless of gender, sexual orientation, disability, ethnicity,
|
disability, ethnicity, religion, or similar personal characteristic.
|
||||||
religion, or similar personal characteristic.
|
- Please avoid using nicknames that might detract from a friendly, safe and welcoming environment for all.
|
||||||
- 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.
|
- We will exclude you from interaction if you insult, demean or harass anyone. In particular, we do not tolerate behavior that
|
||||||
In particular, we do not tolerate behavior that excludes people in socially
|
excludes people in socially marginalized groups.
|
||||||
marginalized groups.
|
- Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made
|
||||||
- Private harassment is also unacceptable. No matter who you are, if you feel
|
uncomfortable by a community member, please contact one of the channel ops or a member of the Ory Ory Hydra Maester core team
|
||||||
you have been or are being harassed or made uncomfortable by a community
|
immediately.
|
||||||
member, please contact one of the channel ops or a member of the Ory Ory Oathkeeper Maester
|
- Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.
|
||||||
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
|
We welcome discussion about creating a welcoming, safe, and productive environment for the community. If you have any questions,
|
||||||
environment for the community. If you have any questions, feedback, or concerns
|
feedback, or concerns [please let us know](https://www.ory.sh/chat).
|
||||||
[please let us know](https://www.ory.sh/chat).
|
|
||||||
|
11
SECURITY.md
11
SECURITY.md
@ -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
|
We release patches for security vulnerabilities. Which versions are eligible receiving such patches depend on the CVSS v3.0
|
||||||
receiving such patches depend on the CVSS v3.0 Rating:
|
Rating:
|
||||||
|
|
||||||
| CVSS v3.0 | Supported Versions |
|
| CVSS v3.0 | Supported Versions |
|
||||||
| --------- | ----------------------------------------- |
|
| --------- | ----------------------------------------- |
|
||||||
@ -31,7 +31,6 @@ receiving such patches depend on the CVSS v3.0 Rating:
|
|||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
Please report (suspected) security vulnerabilities to
|
Please report (suspected) security vulnerabilities to **[security@ory.sh](mailto:security@ory.sh)**. You will receive a response
|
||||||
**[security@ory.sh](mailto:security@ory.sh)**. You will receive a response from
|
from us within 48 hours. If the issue is confirmed, we will release a patch as soon as possible depending on complexity but
|
||||||
us within 48 hours. If the issue is confirmed, we will release a patch as soon
|
historically within a few days.
|
||||||
as possible depending on complexity but historically within a few days.
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user