-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
935cc04
commit 4ef1342
Showing
7 changed files
with
42 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -31,19 +31,19 @@ https://github.com/ory/meta/blob/master/templates/repository/common/CONTRIBUTING | |
|
||
_Please note_: We take Ory $PROJECT's security and our users' trust very | ||
seriously. If you believe you have found a security issue in Ory $PROJECT, | ||
please disclose by contacting us at [email protected]. | ||
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. | ||
|
||
As a potential contributor, your changes and ideas are welcome at any hour of | ||
the day or night, weekdays, weekends, and holidays. Please do not ever hesitate | ||
to ask a question or send a pull request. | ||
the day or night, on weekdays, weekends, and holidays. Please do not ever | ||
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 | ||
won't be yelled at for giving it your best effort. The worst that can happen is | ||
that you'll be politely asked to change something. We appreciate any sort of | ||
contributions, and don't 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, | ||
talk to us! You can find out our thoughts and ensure that your contribution | ||
|
@@ -93,8 +93,8 @@ to help out: | |
look at discussions in the forum and take part in community events. More info | ||
on this in [Communication](#communication). | ||
|
||
- **Answer discussions.** There are at all times a number of unanswered | ||
discussions on GitHub, you can see an | ||
- **Answer discussions.** At all times, there are several unanswered 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 | ||
|
@@ -103,13 +103,13 @@ to help out: | |
- **Help with open issues.** We have a lot of open issues for Ory $PROJECT 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 | ||
the issue template, asking for clarifying information or pointing them to | ||
existing issues that match their description of the problem. | ||
|
||
- **Review documentation changes.** Most documentation just needs a review for | ||
proper spelling and grammar. If you think a 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 documentation [here](#contribute-documentation). | ||
contributing to the documentation [here](#contribute-documentation). | ||
|
||
- **Help with tests.** Pull requests may lack proper tests or test plans. These | ||
are needed for the change to be implemented safely. | ||
|
@@ -122,20 +122,20 @@ questions, discuss bugs and feature requests, talk to other users of Ory, etc. | |
Check out [Ory $PROJECT Discussions]($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 | ||
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 $PROJECT, | ||
consider joining the mailing list. We will _only_ send you vital information on | ||
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). | ||
|
||
## 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 | ||
One of the most impactful ways to contribute is by adding examples. You can find | ||
an overview of examples using Ory services on 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. | ||
|
@@ -147,7 +147,7 @@ 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 | ||
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. | ||
|
@@ -196,13 +196,14 @@ us the rights to use your contribution. You can see the Apache 2.0 license under | |
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 | ||
requests to address the failures until the tests pass. | ||
When pull requests fail the automated testing stages (for example unit or E2E | ||
tests), authors are expected to update their pull requests to address the | ||
failures until the tests pass. | ||
|
||
Pull requests eligible for review | ||
|
||
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 that prove that the change works as intended and does not add | ||
regressions; | ||
3. document the changes in the code and/or the project's documentation; | ||
4. pass the CI pipeline; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. | ||
This text will be included in the changelog. If applicable, include links to documentation or pieces of code. | ||
If your change includes breaking changes please add a codeblock documenting the breaking change: | ||
If your change includes breaking changes please add a code block documenting the breaking change: | ||
``` | ||
BREAKING CHANGES: This patch changes the behavior of configuration item `foo` to do bar. To keep the existing | ||
|
@@ -23,7 +23,7 @@ If this pull request | |
Pull requests introducing new features, which do not have a design document linked are more likely to be rejected and take on average 2-8 weeks longer to | ||
get merged. | ||
You can discuss changes with maintainers either in the Github Discusssions in this repository or | ||
You can discuss changes with maintainers either in the Github Discussions in this repository or | ||
join the [Ory Chat](https://www.ory.sh/chat). | ||
--> | ||
|
||
|
@@ -39,9 +39,9 @@ them, don't hesitate to ask. We're here to help! This is simply a reminder of wh | |
- [ ] 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 green light (please contact [[email protected]](mailto:[email protected])) from the maintainers to push the changes. | ||
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 necessary documentation within the code base (if appropriate). | ||
- [ ] I have added the necessary documentation within the code base (if appropriate). | ||
|
||
## Further comments | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. | ||
This text will be included in the changelog. If applicable, include links to documentation or pieces of code. | ||
If your change includes breaking changes please add a codeblock documenting the breaking change: | ||
If your change includes breaking changes please add a code block documenting the breaking change: | ||
``` | ||
BREAKING CHANGES: This patch changes the behavior of configuration item `foo` to do bar. To keep the existing | ||
|
@@ -23,7 +23,7 @@ If this pull request | |
Pull requests introducing new features, which do not have a design document linked are more likely to be rejected and take on average 2-8 weeks longer to | ||
get merged. | ||
You can discuss changes with maintainers either in the Github Discusssions in this repository or | ||
You can discuss changes with maintainers either in the Github Discussions in this repository or | ||
join the [Ory Chat](https://www.ory.sh/chat). | ||
--> | ||
|
||
|
@@ -42,8 +42,8 @@ If you're unsure about any of them, don't hesitate to ask. We're here to help! | |
- [ ] I am following the [contributing code guidelines](../blob/master/CONTRIBUTING.md#contributing-code). | ||
- [ ] 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 green light (please contact [[email protected]](mailto:[email protected])) from the maintainers to push the changes. | ||
If this pull request addresses a security vulnerability, | ||
I confirm that I got the 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 or changed [the documentation](https://github.com/ory/docs). | ||
|
||
|