Skip to content

Commit 3bd65f1

Browse files
committed
chore: update repository templates to ory/meta@ab9812b
1 parent 4de276a commit 3bd65f1

1 file changed

Lines changed: 90 additions & 40 deletions

File tree

CONTRIBUTING.md

Lines changed: 90 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,21 @@ please disclose it by contacting us at security@ory.com.
2929
There are many ways in which you can contribute. The goal of this document is to
3030
provide a high-level overview of how you can get involved in Ory.
3131

32-
As a potential contributor, your changes and ideas are welcome at any hour of
33-
the day or night, on weekdays, weekends, and holidays. Please do not ever
34-
hesitate to ask a question or send a pull request.
35-
36-
If you are unsure, just ask or submit the issue or pull request anyways. You
37-
won't be yelled at for giving it your best effort. The worst that can happen is
38-
that you'll be politely asked to change something. We appreciate any sort of
39-
contributions and don't want a wall of rules to get in the way of that.
40-
41-
That said, if you want to ensure that a pull request is likely to be merged,
42-
talk to us! You can find out our thoughts and ensure that your contribution
43-
won't clash with Ory
44-
Graceful's direction. A great way to
45-
do this is via
46-
[Ory Graceful Discussions](https://github.com/orgs/ory/discussions)
47-
or the [Ory Chat](https://www.ory.com/chat).
32+
The most valuable way to contribute is to report bugs and request features. If
33+
you would like to propose a change to the code, please **open an issue or a
34+
[discussion](https://github.com/orgs/ory/discussions) first** so we can align on the problem and the
35+
approach before any code is written. We generally do not accept unsolicited pull
36+
requests; see [Contribute code](#contribute-code) for the reasoning and the
37+
process.
38+
39+
If you are unsure, just ask. You won't be yelled at for giving it your best
40+
effort. The worst that can happen is that you'll be politely asked to change
41+
something. We appreciate any sort of contribution and don't want a wall of rules
42+
to get in the way of that.
43+
44+
A great way to start a conversation is via
45+
[Ory Graceful Discussions](https://github.com/orgs/ory/discussions) or the
46+
[Ory Chat](https://www.ory.com/chat).
4847

4948
## FAQ
5049

@@ -71,15 +70,18 @@ or the [Ory Chat](https://www.ory.com/chat).
7170

7271
## How can I contribute?
7372

74-
If you want to start to contribute code right away, take a look at the
75-
[list of good first issues](https://github.com/ory/graceful/labels/good%20first%20issue).
73+
The single most useful thing you can do is to
74+
[open a well-written issue or discussion](https://github.com/ory/graceful/issues):
75+
a clear bug report with a reproducer, or a feature request with concrete use
76+
cases and examples. This is far more valuable to us than a pull request, and it
77+
is the first step for any code change.
7678

77-
There are many other ways you can contribute. Here are a few things you can do
78-
to help out:
79+
There are many other ways you can contribute without writing code. Here are a
80+
few things you can do to help out:
7981

8082
- **Give us a star.** It may not seem like much, but it really makes a
8183
difference. This is something that everyone can do to help out Ory Graceful.
82-
Github stars help the project gain visibility and stand out.
84+
GitHub stars help the project gain visibility and stand out.
8385

8486
- **Join the community.** Sometimes helping people can be as easy as listening
8587
to their problems and offering a different perspective. Join our Slack, have a
@@ -93,6 +95,14 @@ to help out:
9395
help, please share it! Bonus: You get GitHub achievements for answered
9496
discussions.
9597

98+
- **Report bugs.** File a detailed issue when something does not work as
99+
documented. A minimal, reproducible example is worth more than a thousand
100+
words.
101+
102+
- **Request features.** Tell us what you are trying to achieve and why. We would
103+
rather understand the underlying problem than receive a proposed
104+
implementation.
105+
96106
- **Help with open issues.** We have a lot of open issues for Ory Graceful and
97107
some of them may lack necessary information, some are duplicates of older
98108
issues. You can help out by guiding people through the process of filling out
@@ -104,9 +114,6 @@ to help out:
104114
way, feel free to hit the `edit` button at the top of the page. More info on
105115
contributing to the documentation [here](#contribute-documentation).
106116

107-
- **Help with tests.** Pull requests may lack proper tests or test plans. These
108-
are needed for the change to be implemented safely.
109-
110117
## Communication
111118

112119
We use [Slack](https://www.ory.com/chat). You are welcome to drop in and ask
@@ -138,14 +145,28 @@ to add your example or Ory-related project to the awesome-ory README.
138145

139146
## Contribute code
140147

141-
Unless you are fixing a known bug, we **strongly** recommend discussing it with
142-
the core team via a GitHub issue or [in our chat](https://www.ory.com/chat)
143-
before getting started to ensure your work is consistent with Ory Graceful's
144-
roadmap and architecture.
148+
**Please open an issue or [discussion](https://github.com/orgs/ory/discussions) before you write any code,
149+
and wait for a maintainer to agree on the approach.** We do not accept
150+
unsolicited pull requests. Pull requests opened without a prior, agreed-upon
151+
issue will usually be closed with a pointer back to this document.
152+
153+
This may sound unwelcoming, but reviewing an external patch end to end is often
154+
more work than writing the change ourselves.
145155

146-
All contributions are made via pull requests. To make a pull request, you will
147-
need a GitHub account; if you are unclear on this process, see GitHub's
148-
documentation on [forking](https://help.github.com/articles/fork-a-repo) and
156+
So the process is:
157+
158+
1. Open an issue that describes the bug or feature. Include a reproducer,
159+
examples, and the use case you are trying to solve.
160+
2. Wait for a maintainer to confirm the problem and agree on an approach. For
161+
anything beyond a trivial, known bug fix, this step is required.
162+
3. If you would like to include a patch as a proof-of-concept, that is great and
163+
welcome. Please don't be offended if we rewrite it from scratch, take a
164+
different approach, or reimplement the idea.
165+
166+
Once a maintainer has agreed that a pull request is the right next step, open
167+
one. All contributions are made via pull requests, so you will need a GitHub
168+
account; if you are unclear on this process, see GitHub's documentation on
169+
[forking](https://help.github.com/articles/fork-a-repo) and
149170
[pull requests](https://help.github.com/articles/using-pull-requests). Pull
150171
requests should be targeted at the `master` branch. Before creating a pull
151172
request, go through this checklist:
@@ -158,7 +179,7 @@ request, go through this checklist:
158179
1. Run `make format`
159180
1. Add a descriptive prefix to commits. This ensures a uniform commit history
160181
and helps structure the changelog. Please refer to this
161-
[Convential Commits configuration](https://github.com/ory/graceful/blob/master/.github/workflows/conventional_commits.yml)
182+
[Conventional Commits configuration](https://github.com/ory/graceful/blob/master/.github/workflows/conventional_commits.yml)
162183
for the list of accepted prefixes. You can read more about the Conventional
163184
Commit specification
164185
[at their site](https://www.conventionalcommits.org/en/v1.0.0/).
@@ -181,14 +202,15 @@ failures until the tests pass.
181202

182203
Pull requests eligible for review
183204

184-
1. follow the repository's code formatting conventions;
185-
2. include tests that prove that the change works as intended and does not add
205+
1. reference an issue or discussion where a maintainer agreed to the change;
206+
2. follow the repository's code formatting conventions;
207+
3. include tests that prove that the change works as intended and does not add
186208
regressions;
187-
3. document the changes in the code and/or the project's documentation;
188-
4. pass the CI pipeline;
189-
5. have signed our
209+
4. document the changes in the code and/or the project's documentation;
210+
5. pass the CI pipeline;
211+
6. have signed our
190212
[Contributor License Agreement](https://cla-assistant.io/ory/graceful);
191-
6. include a proper git commit message following the
213+
7. include a proper git commit message following the
192214
[Conventional Commit Specification](https://www.conventionalcommits.org/en/v1.0.0/).
193215

194216
If all of these items are checked, the pull request is ready to be reviewed and
@@ -197,6 +219,34 @@ you should change the status to "Ready for review" and
197219

198220
Reviewers will approve the pull request once they are satisfied with the patch.
199221

222+
### AI-assisted contributions
223+
224+
AI can be a valuable aid for writing code, documentation, and tests. However, to
225+
maintain the quality and reliability of Ory Graceful, please follow these
226+
guidelines:
227+
228+
- When submitting a pull request or issue that involved AI assistance, mention
229+
the tools you used and the extent of their involvement. This helps reviewers
230+
understand the context of your contribution.
231+
232+
- Pull requests created with AI assistance should address an existing, accepted
233+
issue. If you have an idea for a new feature or improvement, please open a
234+
discussion or issue first to ensure alignment with the project's direction
235+
before investing time in implementation.
236+
237+
- You must use AI responsibly when writing code. All contributions must be
238+
tested and verified before submission. Unreviewed AI-generated code will not
239+
be accepted, and repeated submissions of this nature may result in restricted
240+
contribution privileges.
241+
242+
- When using AI to help draft issues, discussions, or documentation, review and
243+
edit the output before submitting. AI tends to be verbose. Trim unnecessary
244+
content and ensure your submission is clear and focused.
245+
246+
Contributors must use AI responsibly. These guidelines exist to ensure that
247+
every contribution meets the high standards our community expects, while still
248+
embracing the productivity benefits that AI tools can provide.
249+
200250
## Contribute documentation
201251

202252
Please provide documentation when changing, removing, or adding features. All
@@ -218,10 +268,10 @@ Please run `make format` to format all source code following the Ory standard.
218268

219269
```bash
220270
# First you clone the original repository
221-
git clone git@github.com:ory/ory/graceful.git
271+
git clone git@github.com:ory/graceful.git
222272

223273
# Next you add a git remote that is your fork:
224-
git remote add fork git@github.com:<YOUR-GITHUB-USERNAME-HERE>/ory/graceful.git
274+
git remote add fork git@github.com:<YOUR-GITHUB-USERNAME-HERE>/.git
225275

226276
# Next you fetch the latest changes from origin for master:
227277
git fetch origin

0 commit comments

Comments
 (0)