Skip to content

Commit

Permalink
chore: update repository templates to ory/meta@e54ac5d
Browse files Browse the repository at this point in the history
  • Loading branch information
ory-bot committed Jan 10, 2025
1 parent a5d34f3 commit 4aa6744
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 23 deletions.
20 changes: 13 additions & 7 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,20 @@ 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.
-->

- [ ] 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 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 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 vulnerability,
I confirm that I got approval (please contact [[email protected]](mailto:[email protected])) 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 the necessary documentation within the code base (if appropriate).
- [ ] I confirm that this pull request does not address a security
vulnerability. If this pull request addresses a security vulnerability, I
confirm that I got approval (please contact
[[email protected]](mailto:[email protected])) 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 the necessary documentation within the code base (if
appropriate).

## Further comments

Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/docker-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ on:
branches:
- master
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
group:
${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
build_docker_image:
Expand Down
20 changes: 9 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
## Introduction

_Please note_: We take Ory Ory SDK's security and our users' trust very
seriously. If you believe you have found a security issue in Ory Ory SDK,
please disclose it by contacting us at [email protected].
seriously. If you believe you have found a security issue in Ory Ory SDK, 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
provide a high-level overview of how you can get involved in Ory.
Expand All @@ -40,11 +40,9 @@ 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 SDK's direction. A great way to
do this is via
[Ory Ory SDK Discussions](https://github.com/orgs/ory/discussions)
or the [Ory Chat](https://www.ory.sh/chat).
won't clash with Ory Ory SDK's direction. A great way to do this is via
[Ory Ory SDK Discussions](https://github.com/orgs/ory/discussions) or the
[Ory Chat](https://www.ory.sh/chat).

## FAQ

Expand All @@ -61,8 +59,7 @@ or the [Ory Chat](https://www.ory.sh/chat).
- I want to talk to other Ory Ory SDK 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 SDK.
- I would like to know what I am agreeing to when I contribute to Ory Ory SDK.
Does Ory have
[a Contributors License Agreement?](https://cla-assistant.io/ory/sdk)

Expand Down Expand Up @@ -112,8 +109,9 @@ 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 SDK 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.
Check out [Ory Ory SDK 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
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ All SDKs provided in this repository are generated using openapi-generator.

When developing against [Ory Network](https://www.ory.sh/docs/sdk), use the
latest `client` or `ory-client` SDK for your preferred language. It bundles the
individual SDKs (Identities, OAuth2, Permissions) and works with [Ory API
keys](https://www.ory.sh/docs/concepts/personal-access-token).
individual SDKs (Identities, OAuth2, Permissions) and works with
[Ory API keys](https://www.ory.sh/docs/concepts/personal-access-token).

## Ory self-hosted SDKs

Expand All @@ -30,7 +30,8 @@ docker push oryd/sdk:v0.0.53

## Running the Image Locally

If you wish to debug some generators or build steps, you can run the image locally:
If you wish to debug some generators or build steps, you can run the image
locally:

```shell script
docker build -t oryd/sdk:latest .
Expand All @@ -39,7 +40,8 @@ docker run --mount type=bind,source="$(pwd)",target=/project --name sdk --user "

### Debugging Failing Tests on CI

If a test fails in CI, you may run the following code snippet to reproduce the failure locally:
If a test fails in CI, you may run the following code snippet to reproduce the
failure locally:

```shell script
docker build -t oryd/sdk:latest .
Expand Down

0 comments on commit 4aa6744

Please sign in to comment.