Skip to content

Commit bc603a6

Browse files
authored
chore: update CONTRIBUTING.md (#229)
* chore: update CONTRIBUTING.md * chore: format * chore: fix toc * chore: update sync.sh
1 parent e54ac5d commit bc603a6

File tree

2 files changed

+8
-26
lines changed

2 files changed

+8
-26
lines changed

scripts/sync.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ function replicate_all {
4242
["label-sync-action"]="Label Sync Action"
4343
["milestone-action"]="Milestone Action"
4444
["build-buf-action"]="Buildbuf Action"
45-
["examples"]="Examples"
45+
["awesome-ory"]="Awesome Ory"
4646
["hydra-maester"]="Ory Hydra Maester"
4747
["oathkeeper-maester"]="Ory Oathkeeper Maester"
4848
["sdk"]="Ory SDK"

templates/repository/common/CONTRIBUTING.md

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- [FAQ](#faq)
88
- [How can I contribute?](#how-can-i-contribute)
99
- [Communication](#communication)
10-
- [Contribute examples](#contribute-examples)
10+
- [Contribute examples or community projects](#contribute-examples-or-community-projects)
1111
- [Contribute code](#contribute-code)
1212
- [Contribute documentation](#contribute-documentation)
1313
- [Disclosing vulnerabilities](#disclosing-vulnerabilities)
@@ -122,34 +122,16 @@ the projects that you are interested in.
122122

123123
Also, [follow us on Twitter](https://twitter.com/orycorp).
124124

125-
## Contribute examples
125+
## Contribute examples or community projects
126126

127-
One of the most impactful ways to contribute is by adding examples. You can find
128-
an overview of examples using Ory services on the
129-
[documentation examples page](https://www.ory.sh/docs/examples). Source code for
130-
examples can be found in most cases in the
131-
[ory/examples](https://github.com/ory/examples) repository.
127+
One of the most impactful ways to contribute is by adding code examples or other
128+
Ory-related code. You can find an overview of community code in the
129+
[awesome-ory](https://github.com/ory/awesome-ory) repository.
132130

133131
_If you would like to contribute a new example, we would love to hear from you!_
134132

135-
Please [open an issue](https://github.com/ory/examples/issues/new/choose) to
136-
describe your example before you start working on it. We would love to provide
137-
guidance to make for a pleasant contribution experience. Go through this
138-
checklist to contribute an example:
139-
140-
1. Create a GitHub issue proposing a new example and make sure it's different
141-
from an existing one.
142-
1. Fork the repo and create a feature branch off of `master` so that changes do
143-
not get mixed up.
144-
1. Add a descriptive prefix to commits. This ensures a uniform commit history
145-
and helps structure the changelog. Please refer to this
146-
[Convential Commits configuration](https://github.com/$REPOSITORY/blob/master/.github/workflows/conventional_commits.yml)
147-
for the list of accepted prefixes. You can read more about the Conventional
148-
Commit specification
149-
[at their site](https://www.conventionalcommits.org/en/v1.0.0/).
150-
1. Create a `README.md` that explains how to use the example. (Use
151-
[the README template](https://github.com/ory/examples/blob/master/_common/README.md)).
152-
1. Open a pull request and maintainers will review and merge your example.
133+
Please [open a pull request at awesome-ory](https://github.com/ory/awesome-ory/)
134+
to add your example or Ory-related project to the awesome-ory README.
153135

154136
## Contribute code
155137

0 commit comments

Comments
 (0)