Skip to content

Commit

Permalink
chore: update repository templates to ory/meta@c78ed23
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Aug 7, 2023
1 parent 9ac0027 commit 7b78cdb
Show file tree
Hide file tree
Showing 6 changed files with 76 additions and 81 deletions.
30 changes: 14 additions & 16 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,26 @@ body:
- attributes:
label: "Preflight checklist"
options:
- label:
"I could not find a solution in the existing issues, docs, nor
- label: "I could not find a solution in the existing issues, docs, nor
discussions."
required: true
- label:
"I agree to follow this project's [Code of
Conduct](https://github.com/ory/platform/blob/master/CODE_OF_CONDUCT.md)."
- label: "I agree to follow this project's [Code of
Conduct](https://github.com/ory/network/blob/master/CODE_OF_CONDUCT.md)."
required: true
- label:
"I have read and am following this repository's [Contribution
Guidelines](https://github.com/ory/platform/blob/master/CONTRIBUTING.md)."
- label: "I have read and am following this repository's [Contribution
Guidelines](https://github.com/ory/network/blob/master/CONTRIBUTING.md)."
required: true
- label:
"This issue affects my [Ory Network](https://www.ory.sh/) project."
- label:
"I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label:
"I am signed up to the [Ory Security Patch
- label: "I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label: "I am signed up to the [Ory Security Patch
Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)."
id: checklist
type: checkboxes
- attributes:
description: "Enter the slug or API URL of the affected Ory Network project. Leave empty when you are self-hosting."
label: "Ory Network Project"
placeholder: "https://<your-project-slug>.projects.oryapis.com"
id: ory-network-project
type: input
- attributes:
description: "A clear and concise description of what the bug is."
label: "Describe the bug"
Expand All @@ -56,8 +55,7 @@ body:
validations:
required: true
- attributes:
description:
"Please copy and paste any relevant log output. This will be
description: "Please copy and paste any relevant log output. This will be
automatically formatted into code, so no need for backticks. Please
redact any sensitive information"
label: "Relevant log output"
Expand Down
30 changes: 14 additions & 16 deletions .github/ISSUE_TEMPLATE/DESIGN-DOC.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# AUTO-GENERATED, DO NOT EDIT!
# Please edit the original at https://github.com/ory/meta/blob/master/templates/repository/common/.github/ISSUE_TEMPLATE/DESIGN-DOC.yml

description:
"A design document is needed for non-trivial changes to the code base."
description: "A design document is needed for non-trivial changes to the code base."
labels:
- rfc
name: "Design Document"
Expand All @@ -23,27 +22,26 @@ body:
- attributes:
label: "Preflight checklist"
options:
- label:
"I could not find a solution in the existing issues, docs, nor
- label: "I could not find a solution in the existing issues, docs, nor
discussions."
required: true
- label:
"I agree to follow this project's [Code of
Conduct](https://github.com/ory/platform/blob/master/CODE_OF_CONDUCT.md)."
- label: "I agree to follow this project's [Code of
Conduct](https://github.com/ory/network/blob/master/CODE_OF_CONDUCT.md)."
required: true
- label:
"I have read and am following this repository's [Contribution
Guidelines](https://github.com/ory/platform/blob/master/CONTRIBUTING.md)."
- label: "I have read and am following this repository's [Contribution
Guidelines](https://github.com/ory/network/blob/master/CONTRIBUTING.md)."
required: true
- label:
"This issue affects my [Ory Network](https://www.ory.sh/) project."
- label:
"I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label:
"I am signed up to the [Ory Security Patch
- label: "I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label: "I am signed up to the [Ory Security Patch
Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)."
id: checklist
type: checkboxes
- attributes:
description: "Enter the slug or API URL of the affected Ory Network project. Leave empty when you are self-hosting."
label: "Ory Network Project"
placeholder: "https://<your-project-slug>.projects.oryapis.com"
id: ory-network-project
type: input
- attributes:
description: |
This section gives the reader a very rough overview of the landscape in which the new system is being built and what is actually being built. This isn’t a requirements doc. Keep it succinct! The goal is that readers are brought up to speed but some previous knowledge can be assumed and detailed info can be linked to. This section should be entirely focused on objective background facts.
Expand Down
36 changes: 16 additions & 20 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# AUTO-GENERATED, DO NOT EDIT!
# Please edit the original at https://github.com/ory/meta/blob/master/templates/repository/common/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

description:
"Suggest an idea for this project without a plan for implementation"
description: "Suggest an idea for this project without a plan for implementation"
labels:
- feat
name: "Feature Request"
Expand All @@ -16,30 +15,28 @@ body:
- attributes:
label: "Preflight checklist"
options:
- label:
"I could not find a solution in the existing issues, docs, nor
- label: "I could not find a solution in the existing issues, docs, nor
discussions."
required: true
- label:
"I agree to follow this project's [Code of
Conduct](https://github.com/ory/platform/blob/master/CODE_OF_CONDUCT.md)."
- label: "I agree to follow this project's [Code of
Conduct](https://github.com/ory/network/blob/master/CODE_OF_CONDUCT.md)."
required: true
- label:
"I have read and am following this repository's [Contribution
Guidelines](https://github.com/ory/platform/blob/master/CONTRIBUTING.md)."
- label: "I have read and am following this repository's [Contribution
Guidelines](https://github.com/ory/network/blob/master/CONTRIBUTING.md)."
required: true
- label:
"This issue affects my [Ory Network](https://www.ory.sh/) project."
- label:
"I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label:
"I am signed up to the [Ory Security Patch
- label: "I have joined the [Ory Community Slack](https://slack.ory.sh)."
- label: "I am signed up to the [Ory Security Patch
Newsletter](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)."
id: checklist
type: checkboxes
- attributes:
description:
"Is your feature request related to a problem? Please describe."
description: "Enter the slug or API URL of the affected Ory Network project. Leave empty when you are self-hosting."
label: "Ory Network Project"
placeholder: "https://<your-project-slug>.projects.oryapis.com"
id: ory-network-project
type: input
- attributes:
description: "Is your feature request related to a problem? Please describe."
label: "Describe your problem"
placeholder:
"A clear and concise description of what the problem is. Ex. I'm always
Expand Down Expand Up @@ -73,8 +70,7 @@ body:
validations:
required: true
- attributes:
description:
"Add any other context or screenshots about the feature request here."
description: "Add any other context or screenshots about the feature request here."
label: Additional Context
id: additional
type: textarea
8 changes: 3 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@

blank_issues_enabled: false
contact_links:
- name: Ory Ory Platform Forum
- name: Ory Ory Network Forum
url: https://github.com/orgs/ory/discussions
about:
Please ask and answer questions here, show your implementations and
about: Please ask and answer questions here, show your implementations and
discuss ideas.
- name: Ory Chat
url: https://www.ory.sh/chat
about:
Hang out with other Ory community members to ask and answer questions.
about: Hang out with other Ory community members to ask and answer questions.
5 changes: 5 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ Examples of unacceptable behavior include:
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Open Source Community Support

Ory Open source software is collaborative and based on contributions by developers in the Ory community. There is no obligation from Ory to help with individual problems.
If Ory open source software is used in production in a for-profit company or enterprise environment, we mandate a paid support contract where Ory is obligated under their service level agreements (SLAs) to offer a defined level of availability and responsibility. For more information about paid support please contact us at [email protected].

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
Expand Down
48 changes: 24 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- AUTO-GENERATED, DO NOT EDIT! -->
<!-- Please edit the original at https://github.com/ory/meta/blob/master/templates/repository/common/CONTRIBUTING.md -->

# Contribute to Ory Ory Platform<!-- omit in toc -->
# Contribute to Ory Ory Network<!-- omit in toc -->

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand All @@ -22,8 +22,8 @@

## Introduction

_Please note_: We take Ory Ory Platform's security and our users' trust very
seriously. If you believe you have found a security issue in Ory Ory Platform,
_Please note_: We take Ory Ory Network's security and our users' trust very
seriously. If you believe you have found a security issue in Ory Ory Network,
please disclose it by contacting us at [email protected].

There are many ways in which you can contribute. The goal of this document is to
Expand All @@ -41,44 +41,44 @@ 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 your contribution
won't clash with Ory
Ory Platform's direction. A great way to
Ory Network's direction. A great way to
do this is via
[Ory Ory Platform Discussions](https://github.com/orgs/ory/discussions)
[Ory Ory Network Discussions](https://github.com/orgs/ory/discussions)
or the [Ory Chat](https://www.ory.sh/chat).

## FAQ

- I am new to the community. Where can I find the
[Ory Community Code of Conduct?](https://github.com/ory/platform/blob/master/CODE_OF_CONDUCT.md)
[Ory Community Code of Conduct?](https://github.com/ory/network/blob/master/CODE_OF_CONDUCT.md)

- I have a question. Where can I get
[answers to questions regarding Ory Ory Platform?](#communication)
[answers to questions regarding Ory Ory Network?](#communication)

- 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)

- I want to talk to other Ory Ory Platform users.
- I want to talk to other Ory Ory Network 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
Ory Platform.
Ory Network.
Does Ory have
[a Contributors License Agreement?](https://cla-assistant.io/ory/platform)
[a Contributors License Agreement?](https://cla-assistant.io/ory/network)

- I would like updates about new versions of Ory Ory Platform.
- I would like updates about new versions of Ory Ory Network.
[How are new releases announced?](https://ory.us10.list-manage.com/subscribe?u=ffb1a878e4ec6c0ed312a3480&id=f605a41b53)

## How can I contribute?

If you want to start to contribute code right away, take a look at the
[list of good first issues](https://github.com/ory/platform/labels/good%20first%20issue).
[list of good first issues](https://github.com/ory/network/labels/good%20first%20issue).

There are many other ways you can contribute. 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 out Ory Ory Platform.
difference. This is something that everyone can do to help out Ory Ory Network.
Github stars help the project gain visibility and stand out.

- **Join the community.** Sometimes helping people can be as easy as listening
Expand All @@ -93,7 +93,7 @@ to help out:
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 Platform and
- **Help with open issues.** We have a lot of open issues for Ory Ory Network 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
the issue template, asking for clarifying information or pointing them to
Expand All @@ -112,14 +112,14 @@ to help out:
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.

Check out [Ory Ory Platform Discussions](https://github.com/orgs/ory/discussions). This is a great place for
Check out [Ory Ory Network 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.

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 and participate in
[Slack](https://www.ory.sh/chat) in the #community-call channel.

If you want to receive regular notifications about updates to Ory Ory Platform,
If you want to receive regular notifications about updates to Ory Ory Network,
consider joining the mailing list. We will _only_ send you vital information on
the projects that you are interested in.

Expand All @@ -146,7 +146,7 @@ checklist to contribute an example:
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 Platform](https://github.com/ory/platform/blob/master/.github/semantic.yml)
[list of prefixes for Ory Network](https://github.com/ory/network/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)).
Expand All @@ -156,7 +156,7 @@ checklist to contribute an example:

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)
before getting started to ensure your work is consistent with Ory Ory Platform's
before getting started to ensure your work is consistent with Ory Ory Network's
roadmap and architecture.

All contributions are made via pull requests. To make a pull request, you will
Expand All @@ -174,14 +174,14 @@ request, go through this checklist:
1. Run `make format`
1. Add a descriptive prefix to commits. This ensures a uniform commit history
and helps structure the changelog. Please refer to this
[list of prefixes for Ory Platform](https://github.com/ory/platform/blob/master/.github/semantic.yml)
[list of prefixes for Ory Network](https://github.com/ory/network/blob/master/.github/semantic.yml)
for an overview.

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).

Before your contributions can be reviewed you need to sign our
[Contributor License Agreement](https://cla-assistant.io/ory/platform).
[Contributor License Agreement](https://cla-assistant.io/ory/network).

This agreement defines the terms under which your code is contributed to Ory.
More specifically it declares that you have the right to, and actually do, grant
Expand All @@ -201,7 +201,7 @@ Pull requests eligible for review
3. document the changes in the code and/or the project's documentation;
4. pass the CI pipeline;
5. have signed our
[Contributor License Agreement](https://cla-assistant.io/ory/platform);
[Contributor License Agreement](https://cla-assistant.io/ory/network);
6. include a proper git commit message following the
[Conventional Commit Specification](https://www.conventionalcommits.org/en/v1.0.0/).

Expand Down Expand Up @@ -232,10 +232,10 @@ Please run `make format` to format all source code following the Ory standard.

```bash
# First you clone the original repository
git clone [email protected]:ory/ory/platform.git
git clone [email protected]:ory/ory/network.git

# Next you add a git remote that is your fork:
git remote add fork [email protected]:<YOUR-GITHUB-USERNAME-HERE>/ory/platform.git
git remote add fork [email protected]:<YOUR-GITHUB-USERNAME-HERE>/ory/network.git

# Next you fetch the latest changes from origin for master:
git fetch origin
Expand All @@ -260,7 +260,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
community a safe place for you and we've got your back.

[Ory Community Code of Conduct](https://github.com/ory/platform/blob/master/CODE_OF_CONDUCT.md)
[Ory Community Code of Conduct](https://github.com/ory/network/blob/master/CODE_OF_CONDUCT.md)

We welcome discussion about creating a welcoming, safe, and productive
environment for the community. If you have any questions, feedback, or concerns
Expand Down

0 comments on commit 7b78cdb

Please sign in to comment.