Skip to content

Commit

Permalink
chore: update repository templates (#272)
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Jun 2, 2021
1 parent 0e45bd8 commit 04d0b5e
Showing 1 changed file with 25 additions and 24 deletions.
49 changes: 25 additions & 24 deletions CONTRIBUTING.md
Expand Up @@ -8,7 +8,7 @@ https://github.com/ory/meta/blob/master/templates/repository/common/CONTRIBUTING
-->

# Contributing to ORY Dockertest
# Contributing to Ory Dockertest

<!-- 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 @@ -33,8 +33,8 @@ There are many ways in which you can contribute, beyond writing code. The goal
of this document is to provide a high-level overview of how you can get
involved.

_Please note_: We take ORY Dockertest's security and our users' trust very
seriously. If you believe you have found a security issue in ORY Dockertest,
_Please note_: We take Ory Dockertest's security and our users' trust very
seriously. If you believe you have found a security issue in Ory Dockertest,
please responsibly disclose by contacting us at security@ory.sh.

First: As a potential contributor, your changes and ideas are welcome at any
Expand All @@ -48,33 +48,33 @@ 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 or be obviated by ORY
won't clash or be obviated by Ory
Dockertest's normal direction. A great way to
do this is via
[ORY Dockertest Discussions](https://github.com/ory/meta/discussions)
or the [ORY Chat](https://www.ory.sh/chat).
[Ory Dockertest Discussions](https://github.com/ory/meta/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/dockertest/blob/master/CODE_OF_CONDUCT.md)
[Ory Community Code of Conduct?](https://github.com/ory/dockertest/blob/master/CODE_OF_CONDUCT.md)

- I have a question. Where can I get
[answers to questions regarding ORY Dockertest?](#communication)
[answers to questions regarding Ory Dockertest?](#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 Dockertest users.
- I want to talk to other Ory Dockertest 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
Dockertest.
Does ORY have
Does Ory have
[a Contributors License Agreement?](https://cla-assistant.io/ory/dockertest)

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

## How can I contribute?
Expand All @@ -86,15 +86,15 @@ 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 out ORY Dockertest.
difference. This is something that everyone can do to help out Ory Dockertest.
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 perspective. Join our Slack, have a
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 Dockertest
- **Helping with open issues.** We have a lot of open issues for Ory Dockertest
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 @@ -111,16 +111,16 @@ a few things you can do to help out:
## 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 other users of ORY, etc.
questions, discuss bugs and feature requests, talk to other users of Ory, etc.

Check out [ORY Dockertest Discussions](https://github.com/ory/meta/discussions). This is a great place for
Check out [Ory Dockertest Discussions](https://github.com/ory/meta/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 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 info on the hangouts in
[Slack](https://www.ory.sh/chat).

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

Expand All @@ -130,7 +130,7 @@ Also [follow us on twitter](https://twitter.com/orycorp).

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

All contributions are made via pull request. Note that **all patches from all
Expand All @@ -147,7 +147,7 @@ from maintainers).
Before your contributions can be merged you need to sign our
[Contributor License Agreement](https://cla-assistant.io/ory/dockertest).

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 right to, and actually do, grant
us the rights to use your contribution. You can see the Apache 2.0 license under
which our projects are published
Expand Down Expand Up @@ -195,9 +195,10 @@ request, go through this checklist:
1. Run the full project test suite with the `go test ./...` (or equivalent)
command and confirm that it passes.
1. Run `gofmt -s` (if the project is written in Go).
1. Ensure that each commit has a subsystem prefix (ex: `controller:`).
[List of subsystem prefixes for Dockertest](https://github.com/ory/ory/dockertest/blob/master/.github/semantic.yml)
(if applicable).
1. Ensure that each commit has a descriptive prefix. This ensures a uniform
commit history and helps structure the changelog.
Please refer to this
[list of prefixes for Dockertest](https://github.com/ory/dockertest/blob/master/.github/semantic.yml).

Pull requests will be treated as "review requests," and maintainers will give
feedback on the style and substance of the patch.
Expand Down Expand Up @@ -249,7 +250,7 @@ community a safe place for you and we've got your back.
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 Dockertest
member, please contact one of the channel ops or a member of the Ory Dockertest
core team immediately.
- Likewise any spamming, trolling, flaming, baiting or other attention-stealing
behaviour is not welcome.
Expand Down

0 comments on commit 04d0b5e

Please sign in to comment.