@@ -29,19 +29,19 @@ Resources, please disclose it by contacting us at security@ory.com.
2929There are many ways in which you can contribute. The goal of this document is to
3030provide 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 Kubernetes Resources's direction. A great way to do this is
44- via
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
35+ the problem and the approach before any code is written. We generally do not
36+ accept unsolicited pull requests; see [ Contribute code ] ( #contribute-code ) for
37+ the reasoning and the 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
4545[ Ory Kubernetes Resources Discussions] ( https://github.com/orgs/ory/discussions )
4646or the [ Ory Chat] ( https://www.ory.com/chat ) .
4747
@@ -69,15 +69,18 @@ or the [Ory Chat](https://www.ory.com/chat).
6969
7070## How can I contribute?
7171
72- If you want to start to contribute code right away, take a look at the
73- [ list of good first issues] ( https://github.com/ory/k8s/labels/good%20first%20issue ) .
72+ The single most useful thing you can do is to
73+ [ open a well-written issue or discussion] ( https://github.com/ory/k8s/issues ) : a
74+ clear bug report with a reproducer, or a feature request with concrete use cases
75+ and examples. This is far more valuable to us than a pull request, and it is the
76+ first step for any code change.
7477
75- There are many other ways you can contribute. Here are a few things you can do
76- to help out:
78+ There are many other ways you can contribute without writing code . Here are a
79+ few things you can do to help out:
7780
7881- ** Give us a star.** It may not seem like much, but it really makes a
7982 difference. This is something that everyone can do to help out Ory Kubernetes
80- Resources. Github stars help the project gain visibility and stand out.
83+ Resources. GitHub stars help the project gain visibility and stand out.
8184
8285- ** Join the community.** Sometimes helping people can be as easy as listening
8386 to their problems and offering a different perspective. Join our Slack, have a
@@ -91,6 +94,14 @@ to help out:
9194 help, please share it! Bonus: You get GitHub achievements for answered
9295 discussions.
9396
97+ - ** Report bugs.** File a detailed issue when something does not work as
98+ documented. A minimal, reproducible example is worth more than a thousand
99+ words.
100+
101+ - ** Request features.** Tell us what you are trying to achieve and why. We would
102+ rather understand the underlying problem than receive a proposed
103+ implementation.
104+
94105- ** Help with open issues.** We have a lot of open issues for Ory Kubernetes
95106 Resources and some of them may lack necessary information, some are duplicates
96107 of older issues. You can help out by guiding people through the process of
@@ -102,9 +113,6 @@ to help out:
102113 way, feel free to hit the ` edit ` button at the top of the page. More info on
103114 contributing to the documentation [ here] ( #contribute-documentation ) .
104115
105- - ** Help with tests.** Pull requests may lack proper tests or test plans. These
106- are needed for the change to be implemented safely.
107-
108116## Communication
109117
110118We use [ Slack] ( https://www.ory.com/chat ) . You are welcome to drop in and ask
@@ -138,14 +146,29 @@ to add your example or Ory-related project to the awesome-ory README.
138146
139147## Contribute code
140148
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 Kubernetes
144- Resources's roadmap and architecture.
145-
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
149+ ** Please open an issue or [ discussion] ( https://github.com/orgs/ory/discussions )
150+ before you write any code, and wait for a maintainer to agree on the approach.**
151+ We do not accept unsolicited pull requests. Pull requests opened without a
152+ prior, agreed-upon issue will usually be closed with a pointer back to this
153+ document.
154+
155+ This may sound unwelcoming, but reviewing an external patch end to end is often
156+ more work than writing the change ourselves.
157+
158+ So the process is:
159+
160+ 1 . Open an issue that describes the bug or feature. Include a reproducer,
161+ examples, and the use case you are trying to solve.
162+ 2 . Wait for a maintainer to confirm the problem and agree on an approach. For
163+ anything beyond a trivial, known bug fix, this step is required.
164+ 3 . If you would like to include a patch as a proof-of-concept, that is great and
165+ welcome. Please don't be offended if we rewrite it from scratch, take a
166+ different approach, or reimplement the idea.
167+
168+ Once a maintainer has agreed that a pull request is the right next step, open
169+ one. All contributions are made via pull requests, so you will need a GitHub
170+ account; if you are unclear on this process, see GitHub's documentation on
171+ [ forking] ( https://help.github.com/articles/fork-a-repo ) and
149172[ pull requests] ( https://help.github.com/articles/using-pull-requests ) . Pull
150173requests should be targeted at the ` master ` branch. Before creating a pull
151174request, go through this checklist:
@@ -158,7 +181,7 @@ request, go through this checklist:
1581811 . Run ` make format `
1591821 . Add a descriptive prefix to commits. This ensures a uniform commit history
160183 and helps structure the changelog. Please refer to this
161- [ Convential Commits configuration] ( https://github.com/ory/k8s/blob/master/.github/workflows/conventional_commits.yml )
184+ [ Conventional Commits configuration] ( https://github.com/ory/k8s/blob/master/.github/workflows/conventional_commits.yml )
162185 for the list of accepted prefixes. You can read more about the Conventional
163186 Commit specification
164187 [ at their site] ( https://www.conventionalcommits.org/en/v1.0.0/ ) .
@@ -181,14 +204,15 @@ failures until the tests pass.
181204
182205Pull requests eligible for review
183206
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
207+ 1 . reference an issue or discussion where a maintainer agreed to the change;
208+ 2 . follow the repository's code formatting conventions;
209+ 3 . include tests that prove that the change works as intended and does not add
186210 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
211+ 4 . document the changes in the code and/or the project's documentation;
212+ 5 . pass the CI pipeline;
213+ 6 . have signed our
190214 [ Contributor License Agreement] ( https://cla-assistant.io/ory/k8s ) ;
191- 6 . include a proper git commit message following the
215+ 7 . include a proper git commit message following the
192216 [ Conventional Commit Specification] ( https://www.conventionalcommits.org/en/v1.0.0/ ) .
193217
194218If all of these items are checked, the pull request is ready to be reviewed and
@@ -197,6 +221,34 @@ you should change the status to "Ready for review" and
197221
198222Reviewers will approve the pull request once they are satisfied with the patch.
199223
224+ ### AI-assisted contributions
225+
226+ AI can be a valuable aid for writing code, documentation, and tests. However, to
227+ maintain the quality and reliability of Ory Kubernetes Resources, please follow
228+ these guidelines:
229+
230+ - When submitting a pull request or issue that involved AI assistance, mention
231+ the tools you used and the extent of their involvement. This helps reviewers
232+ understand the context of your contribution.
233+
234+ - Pull requests created with AI assistance should address an existing, accepted
235+ issue. If you have an idea for a new feature or improvement, please open a
236+ discussion or issue first to ensure alignment with the project's direction
237+ before investing time in implementation.
238+
239+ - You must use AI responsibly when writing code. All contributions must be
240+ tested and verified before submission. Unreviewed AI-generated code will not
241+ be accepted, and repeated submissions of this nature may result in restricted
242+ contribution privileges.
243+
244+ - When using AI to help draft issues, discussions, or documentation, review and
245+ edit the output before submitting. AI tends to be verbose. Trim unnecessary
246+ content and ensure your submission is clear and focused.
247+
248+ Contributors must use AI responsibly. These guidelines exist to ensure that
249+ every contribution meets the high standards our community expects, while still
250+ embracing the productivity benefits that AI tools can provide.
251+
200252## Contribute documentation
201253
202254Please provide documentation when changing, removing, or adding features. All
@@ -218,10 +270,10 @@ Please run `make format` to format all source code following the Ory standard.
218270
219271``` bash
220272# First you clone the original repository
221- git clone git@github.com:ory/ory/ k8s.git
273+ git clone git@github.com:ory/k8s.git
222274
223275# Next you add a git remote that is your fork:
224- git remote add fork git@github.com:< YOUR-GITHUB-USERNAME-HERE> /ory/k8s .git
276+ git remote add fork git@github.com:< YOUR-GITHUB-USERNAME-HERE> /.git
225277
226278# Next you fetch the latest changes from origin for master:
227279git fetch origin
0 commit comments