chore: update repository templates
[skip ci] - updated repository templates to 8a3d37122f
This commit is contained in:
parent
de005e9894
commit
1e7773c72d
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -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,76 +2,131 @@
|
|||||||
|
|
||||||
## Our Pledge
|
## Our Pledge
|
||||||
|
|
||||||
In the interest of fostering an open and welcoming environment, we as
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
contributors and maintainers pledge to making participation in our project and
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
our community a harassment-free experience for everyone, regardless of age, body
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
size, disability, ethnicity, sex characteristics, gender identity and
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
expression, level of experience, education, socio-economic status, nationality,
|
nationality, personal appearance, race, caste, color, religion, or sexual
|
||||||
personal appearance, race, religion, or sexual identity and orientation.
|
identity and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
## Our Standards
|
## Our Standards
|
||||||
|
|
||||||
Examples of behavior that contributes to creating a positive environment
|
Examples of behavior that contributes to a positive environment for our
|
||||||
include:
|
community include:
|
||||||
|
|
||||||
- Using welcoming and inclusive language
|
- Demonstrating empathy and kindness toward other people
|
||||||
- Being respectful of differing viewpoints and experiences
|
- Being respectful of differing opinions, viewpoints, and experiences
|
||||||
- Gracefully accepting constructive criticism
|
- Giving and gracefully accepting constructive feedback
|
||||||
- Focusing on what is best for the community
|
- Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
- Showing empathy towards other community members
|
and learning from the experience
|
||||||
|
- Focusing on what is best not just for us as individuals, but for the overall
|
||||||
|
community
|
||||||
|
|
||||||
Examples of unacceptable behavior by participants include:
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
- The use of sexualized language or imagery and unwelcome sexual attention or
|
- The use of sexualized language or imagery, and sexual attention or advances of
|
||||||
advances
|
any kind
|
||||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
- Trolling, insulting or 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 email address,
|
||||||
address, without explicit permission
|
without their explicit permission
|
||||||
- Other conduct which could reasonably be considered inappropriate in a
|
- Other conduct which could reasonably be considered inappropriate in a
|
||||||
professional setting
|
professional setting
|
||||||
|
|
||||||
## Our Responsibilities
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
Project maintainers are responsible for clarifying the standards of acceptable
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
behavior and are expected to take appropriate and fair corrective action in
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
response to any instances of unacceptable behavior.
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
Project maintainers have the right and responsibility to remove, edit, or reject
|
Community leaders have the right and responsibility to remove, edit, or reject
|
||||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||||
not aligned to this Code of Conduct, or to ban temporarily or permanently any
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||||
contributor for other behaviors that they deem inappropriate, threatening,
|
decisions when appropriate.
|
||||||
offensive, or harmful.
|
|
||||||
|
|
||||||
## Scope
|
## Scope
|
||||||
|
|
||||||
This Code of Conduct applies both within project spaces and in public spaces
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
when an individual is representing the project or its community. Examples of
|
an individual is officially representing the community in public spaces.
|
||||||
representing a project or community include using an official project e-mail
|
Examples of representing our community include using an official e-mail address,
|
||||||
address, posting via an official social media account, or acting as an appointed
|
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
|
representative at an online or offline event.
|
||||||
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 office@ory.sh. All complaints will be
|
reported to the community leaders responsible for enforcement at
|
||||||
reviewed and investigated and will result in a response that is deemed necessary
|
[office@ory.sh](mailto:office@ory.sh). All complaints will be reviewed and
|
||||||
and appropriate to the circumstances. The project team is obligated to maintain
|
investigated promptly and fairly.
|
||||||
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
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
faith may face temporary or permanent repercussions as determined by other
|
reporter of any incident.
|
||||||
members of the project's leadership.
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series of
|
||||||
|
actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or permanent
|
||||||
|
ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within the
|
||||||
|
community.
|
||||||
|
|
||||||
## 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 2.1, available at
|
||||||
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
||||||
|
|
||||||
|
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||||
|
enforcement ladder][mozilla coc].
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
|
||||||
|
[https://www.contributor-covenant.org/translations][translations].
|
||||||
|
|
||||||
[homepage]: https://www.contributor-covenant.org
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||||
For answers to common questions about this code of conduct, see
|
[mozilla coc]: https://github.com/mozilla/diversity
|
||||||
https://www.contributor-covenant.org/faq
|
[faq]: https://www.contributor-covenant.org/faq
|
||||||
|
[translations]: https://www.contributor-covenant.org/translations
|
||||||
|
160
CONTRIBUTING.md
160
CONTRIBUTING.md
@ -8,7 +8,7 @@ https://github.com/ory/meta/blob/master/templates/repository/common/CONTRIBUTING
|
|||||||
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Contributing to Ory Ory Oathkeeper Maester
|
# Contribute 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 -->
|
||||||
@ -17,28 +17,28 @@ https://github.com/ory/meta/blob/master/templates/repository/common/CONTRIBUTING
|
|||||||
- [FAQ](#faq)
|
- [FAQ](#faq)
|
||||||
- [How can I contribute?](#how-can-i-contribute)
|
- [How can I contribute?](#how-can-i-contribute)
|
||||||
- [Communication](#communication)
|
- [Communication](#communication)
|
||||||
- [Contributing Code](#contributing-code)
|
- [Contribute examples](#contribute-examples)
|
||||||
- [Documentation](#documentation)
|
- [Contribute code](#contribute-code)
|
||||||
|
- [Contribute documentation](#contribute-documentation)
|
||||||
- [Disclosing vulnerabilities](#disclosing-vulnerabilities)
|
- [Disclosing vulnerabilities](#disclosing-vulnerabilities)
|
||||||
- [Code Style](#code-style)
|
- [Code style](#code-style)
|
||||||
- [Working with Forks](#working-with-forks)
|
- [Working with forks](#working-with-forks)
|
||||||
- [Conduct](#conduct)
|
- [Conduct](#conduct)
|
||||||
|
|
||||||
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
There are many ways in which you can contribute, beyond writing code. The goal
|
_Please note_: We take Ory Ory Hydra Maester's security and our users' trust very
|
||||||
of this document is to provide a high-level overview of how you can get
|
seriously. If you believe you have found a security issue in Ory Ory Hydra Maester,
|
||||||
involved.
|
please disclose by contacting us at security@ory.sh.
|
||||||
|
|
||||||
_Please note_: We take Ory Ory Oathkeeper Maester's security and our users' trust very
|
There are many ways in which you can contribute. The goal of this document is to
|
||||||
seriously. If you believe you have found a security issue in Ory Ory Oathkeeper Maester,
|
provide a high-level overview of how you can get involved in Ory.
|
||||||
please responsibly disclose by contacting us at security@ory.sh.
|
|
||||||
|
|
||||||
First: As a potential contributor, your changes and ideas are welcome at any
|
As a potential contributor, your changes and ideas are welcome at any hour of
|
||||||
hour of the day or night, weekdays, weekends, and holidays. Please do not ever
|
the day or night, weekdays, weekends, and holidays. Please do not ever hesitate
|
||||||
hesitate to ask a question or send a pull request.
|
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. The worst that can happen is
|
won't be yelled at for giving it your best effort. The worst that can happen is
|
||||||
@ -47,10 +47,10 @@ 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 that your contribution
|
talk to us! You can find out our thoughts and ensure that your contribution
|
||||||
won't clash or be obviated by Ory
|
won't clash with Ory
|
||||||
Ory Oathkeeper Maester's normal direction. A great way to
|
Ory Hydra Maester's 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 [Ory Chat](https://www.ory.sh/chat).
|
or the [Ory Chat](https://www.ory.sh/chat).
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
@ -59,77 +59,111 @@ or the [Ory Chat](https://www.ory.sh/chat).
|
|||||||
[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 Oathkeeper Maester?](#communication)
|
[answers to questions regarding Ory Ory Hydra 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?
|
||||||
|
|
||||||
If you want to start contributing code right away, we have a
|
If you want to start to contribute code right away, take a look at the
|
||||||
[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. Here are a few things you can do
|
||||||
a few things you can do to help out:
|
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 out Ory Ory Oathkeeper Maester.
|
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.
|
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 perspective. Join our Slack, have a
|
to their problems and offering a different perspective. Join our Slack, have a
|
||||||
look at discussions in the forum and take part in our weekly hangout. More
|
look at discussions in the forum and take part in community events. More info
|
||||||
info on this in [Communication](#communication).
|
on this in [Communication](#communication).
|
||||||
|
|
||||||
- **Helping with open issues.** We have a lot of open issues for Ory Ory Oathkeeper Maester
|
- **Answer discussions.** There are at all times a number of unanswered
|
||||||
and some of them may lack necessary information, some are duplicates of older
|
discussions on GitHub, you can see an
|
||||||
|
[overview here](https://github.com/discussions?discussions_q=is%3Aunanswered+org%3Aory+sort%3Aupdated-desc).
|
||||||
|
If you think you know an answer or can provide some information that might
|
||||||
|
help, please share it! Bonus: You get GitHub achievements for answered
|
||||||
|
discussions.
|
||||||
|
|
||||||
|
- **Help with open issues.** We have a lot of open issues for Ory Ory Hydra Maester and
|
||||||
|
some of them may lack necessary information, some are duplicates of older
|
||||||
issues. You can help out by guiding people through the process of filling out
|
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
|
the issue template, asking for clarifying information, or pointing them to
|
||||||
existing issues that match their description of the problem.
|
existing issues that match their description of the problem.
|
||||||
|
|
||||||
- **Reviewing documentation changes.** Most documentation just needs a review
|
- **Review documentation changes.** Most documentation just needs a review for
|
||||||
for proper spelling and grammar. If you think a document can be improved in
|
proper spelling and grammar. If you think a document can be improved in any
|
||||||
any way, feel free to hit the `edit` button at the top of the page. More info
|
way, feel free to hit the `edit` button at the top of the page. More info on
|
||||||
on contributing to documentation [here](#documentation).
|
contributing to documentation [here](#contribute-documentation).
|
||||||
|
|
||||||
- **Help with tests.** Some pull requests may lack proper tests or test plans.
|
- **Help with tests.** Pull requests may lack proper tests or test plans. These
|
||||||
These are needed for the change to be implemented safely.
|
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
|
We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask
|
||||||
questions, discuss bugs and feature requests, talk to 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
|
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 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
|
You can also join our community calls, if you want to speak to the Ory team
|
||||||
directly or ask some questions. You can find more info on the hangouts in
|
directly or ask some questions. You can find more info and participate in
|
||||||
[Slack](https://www.ory.sh/chat).
|
[Slack](https://www.ory.sh/chat) in the #community-call channel.
|
||||||
|
|
||||||
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 you vital information on
|
consider joining the mailing list. We will _only_ send 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
|
## Contribute examples
|
||||||
|
|
||||||
|
One of the most impactful ways to make a contribution is adding examples. You
|
||||||
|
can find an overview of examples using Ory services in the
|
||||||
|
[documentation examples page](https://www.ory.sh/docs/examples). Source code for
|
||||||
|
examples can be found in most cases in the
|
||||||
|
[ory/examples](https://github.com/ory/examples) repository.
|
||||||
|
|
||||||
|
_If you would like to contribute a new example, we would love to hear from you!_
|
||||||
|
|
||||||
|
Please [open an issue](https://github.com/ory/examples/issues/new/choose) to
|
||||||
|
describe your example before you start working on it. We would love to provide
|
||||||
|
guidance to make for a pleasant contribution experience. Go through this
|
||||||
|
checklist to contribute an example:
|
||||||
|
|
||||||
|
1. Create a github issue proposing a new example and make sure it's different
|
||||||
|
from an existing one.
|
||||||
|
1. Fork the repo and create a feature branch off of `master` so that changes do
|
||||||
|
not get mixed up.
|
||||||
|
1. Add a descriptive prefix to commits. This ensures a uniform commit history
|
||||||
|
and helps structure the changelog. 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. Create a `README.md` that explains how to use the example. (Use
|
||||||
|
[the README template](https://github.com/ory/examples/blob/master/_common/README)).
|
||||||
|
1. Open a pull request and maintainers will review and merge your example.
|
||||||
|
|
||||||
|
## Contribute 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 [in our chat](https://www.ory.sh/chat)
|
the core team via a GitHub issue or [in our chat](https://www.ory.sh/chat)
|
||||||
before getting started to ensure your work is consistent with Ory Ory Oathkeeper Maester's
|
before getting started to ensure your work is consistent with Ory Ory Hydra Maester's
|
||||||
roadmap and 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
|
||||||
@ -146,10 +180,10 @@ request, go through this checklist:
|
|||||||
equivalent) command and confirm that it passes.
|
equivalent) command and confirm that it passes.
|
||||||
1. Run `make format` if a `Makefile` is available, `gofmt -s` if the project is
|
1. Run `make format` if a `Makefile` is available, `gofmt -s` if the project is
|
||||||
written in Go, `npm run format` if the project is written for NodeJS.
|
written in Go, `npm run format` if the project is written for NodeJS.
|
||||||
1. Ensure that each commit has a descriptive prefix. This ensures a uniform
|
1. Add a descriptive prefix to commits. This ensures a uniform commit history
|
||||||
commit history and helps structure the changelog.
|
and helps structure the changelog.
|
||||||
Please refer to this
|
Please refer to this
|
||||||
[list of prefixes for Ory Oathkeeper Maester](https://github.com/ory/hydra-maester/blob/master/.github/semantic.yml)
|
[list of prefixes for Ory Hydra Maester](https://github.com/ory/hydra-maester/blob/master/.github/semantic.yml)
|
||||||
for an overview.
|
for an overview.
|
||||||
1. Sign-up with CircleCI so that it has access to your repository with the
|
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
|
branch containing your PR. Simply creating a CircleCI account is sufficient
|
||||||
@ -189,22 +223,20 @@ you should change the status to "Ready for review" and
|
|||||||
|
|
||||||
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
|
## Contribute documentation
|
||||||
|
|
||||||
Please provide documentation when changing, removing, or adding features.
|
Please provide documentation when changing, removing, or adding features. All
|
||||||
Documentation resides in the project's
|
Ory Documentation resides in the
|
||||||
[docs](https://github.com/ory/hydra-maester/tree/master/docs) folder. Generate API and
|
[Ory documentation repository](https://github.com/ory/docs/). For further
|
||||||
configuration reference documentation using `cd docs; npm run gen`.
|
instructions please head over to the Ory Documentation
|
||||||
|
[README.md](https://github.com/ory/docs/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
|
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:
|
||||||
|
|
||||||
@ -212,9 +244,9 @@ Please follow these guidelines when formatting source code:
|
|||||||
- 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
|
||||||
|
|
||||||
```
|
```bash
|
||||||
# First you clone the original repository
|
# First you clone the original repository
|
||||||
git clone git@github.com:ory/ory/hydra-maester.git
|
git clone git@github.com:ory/ory/hydra-maester.git
|
||||||
|
|
||||||
@ -244,21 +276,7 @@ Now go to the project's GitHub Pull Request page and click "New pull request"
|
|||||||
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 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
|
[Ory Community Code of Conduct](https://github.com/ory/hydra-maester/blob/master/CODE_OF_CONDUCT.md)
|
||||||
all, regardless of gender, sexual orientation, disability, ethnicity,
|
|
||||||
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.
|
|
||||||
- We will exclude you from interaction if you insult, demean or harass anyone.
|
|
||||||
In particular, we do not tolerate behavior that excludes people in socially
|
|
||||||
marginalized groups.
|
|
||||||
- Private harassment is also unacceptable. No matter who you are, if you feel
|
|
||||||
you have been or are being harassed or made uncomfortable by a community
|
|
||||||
member, please contact one of the channel ops or a member of the Ory Ory Oathkeeper 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
|
We welcome discussion about creating a welcoming, safe, and productive
|
||||||
environment for the community. If you have any questions, feedback, or concerns
|
environment for the community. If you have any questions, feedback, or concerns
|
||||||
|
Loading…
x
Reference in New Issue
Block a user