@@ -29,18 +29,19 @@ 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 CLI's direction. A great way to do this is 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
4445[ Ory CLI Discussions] ( https://github.com/orgs/ory/discussions ) or the
4546[ Ory Chat] ( https://www.ory.com/chat ) .
4647
@@ -67,14 +68,17 @@ won't clash with Ory CLI's direction. A great way to do this is via
6768
6869## How can I contribute?
6970
70- If you want to start to contribute code right away, take a look at the
71- [ list of good first issues] ( https://github.com/ory/cli/labels/good%20first%20issue ) .
71+ The single most useful thing you can do is to
72+ [ open a well-written issue or discussion] ( https://github.com/ory/cli/issues ) : a
73+ clear bug report with a reproducer, or a feature request with concrete use cases
74+ and examples. This is far more valuable to us than a pull request, and it is the
75+ first step for any code change.
7276
73- There are many other ways you can contribute. Here are a few things you can do
74- to help out:
77+ There are many other ways you can contribute without writing code . Here are a
78+ few things you can do to help out:
7579
7680- ** Give us a star.** It may not seem like much, but it really makes a
77- difference. This is something that everyone can do to help out Ory CLI. Github
81+ difference. This is something that everyone can do to help out Ory CLI. GitHub
7882 stars help the project gain visibility and stand out.
7983
8084- ** Join the community.** Sometimes helping people can be as easy as listening
@@ -89,6 +93,14 @@ to help out:
8993 help, please share it! Bonus: You get GitHub achievements for answered
9094 discussions.
9195
96+ - ** Report bugs.** File a detailed issue when something does not work as
97+ documented. A minimal, reproducible example is worth more than a thousand
98+ words.
99+
100+ - ** Request features.** Tell us what you are trying to achieve and why. We would
101+ rather understand the underlying problem than receive a proposed
102+ implementation.
103+
92104- ** Help with open issues.** We have a lot of open issues for Ory CLI and some
93105 of them may lack necessary information, some are duplicates of older issues.
94106 You can help out by guiding people through the process of filling out the
@@ -100,9 +112,6 @@ to help out:
100112 way, feel free to hit the ` edit ` button at the top of the page. More info on
101113 contributing to the documentation [ here] ( #contribute-documentation ) .
102114
103- - ** Help with tests.** Pull requests may lack proper tests or test plans. These
104- are needed for the change to be implemented safely.
105-
106115## Communication
107116
108117We use [ Slack] ( https://www.ory.com/chat ) . You are welcome to drop in and ask
@@ -135,14 +144,29 @@ to add your example or Ory-related project to the awesome-ory README.
135144
136145## Contribute code
137146
138- Unless you are fixing a known bug, we ** strongly** recommend discussing it with
139- the core team via a GitHub issue or [ in our chat] ( https://www.ory.com/chat )
140- before getting started to ensure your work is consistent with Ory CLI's roadmap
141- and architecture.
142-
143- All contributions are made via pull requests. To make a pull request, you will
144- need a GitHub account; if you are unclear on this process, see GitHub's
145- documentation on [ forking] ( https://help.github.com/articles/fork-a-repo ) and
147+ ** Please open an issue or [ discussion] ( https://github.com/orgs/ory/discussions )
148+ before you write any code, and wait for a maintainer to agree on the approach.**
149+ We do not accept unsolicited pull requests. Pull requests opened without a
150+ prior, agreed-upon issue will usually be closed with a pointer back to this
151+ 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.
155+
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
146170[ pull requests] ( https://help.github.com/articles/using-pull-requests ) . Pull
147171requests should be targeted at the ` master ` branch. Before creating a pull
148172request, go through this checklist:
@@ -155,7 +179,7 @@ request, go through this checklist:
1551791 . Run ` make format `
1561801 . Add a descriptive prefix to commits. This ensures a uniform commit history
157181 and helps structure the changelog. Please refer to this
158- [ Convential Commits configuration] ( https://github.com/ory/cli/blob/master/.github/workflows/conventional_commits.yml )
182+ [ Conventional Commits configuration] ( https://github.com/ory/cli/blob/master/.github/workflows/conventional_commits.yml )
159183 for the list of accepted prefixes. You can read more about the Conventional
160184 Commit specification
161185 [ at their site] ( https://www.conventionalcommits.org/en/v1.0.0/ ) .
@@ -178,14 +202,15 @@ failures until the tests pass.
178202
179203Pull requests eligible for review
180204
181- 1 . follow the repository's code formatting conventions;
182- 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
183208 regressions;
184- 3 . document the changes in the code and/or the project's documentation;
185- 4 . pass the CI pipeline;
186- 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
187212 [ Contributor License Agreement] ( https://cla-assistant.io/ory/cli ) ;
188- 6 . include a proper git commit message following the
213+ 7 . include a proper git commit message following the
189214 [ Conventional Commit Specification] ( https://www.conventionalcommits.org/en/v1.0.0/ ) .
190215
191216If all of these items are checked, the pull request is ready to be reviewed and
@@ -194,6 +219,33 @@ you should change the status to "Ready for review" and
194219
195220Reviewers will approve the pull request once they are satisfied with the patch.
196221
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 CLI, please follow these guidelines:
226+
227+ - When submitting a pull request or issue that involved AI assistance, mention
228+ the tools you used and the extent of their involvement. This helps reviewers
229+ understand the context of your contribution.
230+
231+ - Pull requests created with AI assistance should address an existing, accepted
232+ issue. If you have an idea for a new feature or improvement, please open a
233+ discussion or issue first to ensure alignment with the project's direction
234+ before investing time in implementation.
235+
236+ - You must use AI responsibly when writing code. All contributions must be
237+ tested and verified before submission. Unreviewed AI-generated code will not
238+ be accepted, and repeated submissions of this nature may result in restricted
239+ contribution privileges.
240+
241+ - When using AI to help draft issues, discussions, or documentation, review and
242+ edit the output before submitting. AI tends to be verbose. Trim unnecessary
243+ content and ensure your submission is clear and focused.
244+
245+ Contributors must use AI responsibly. These guidelines exist to ensure that
246+ every contribution meets the high standards our community expects, while still
247+ embracing the productivity benefits that AI tools can provide.
248+
197249## Contribute documentation
198250
199251Please provide documentation when changing, removing, or adding features. All
@@ -215,10 +267,10 @@ Please run `make format` to format all source code following the Ory standard.
215267
216268``` bash
217269# First you clone the original repository
218- git clone git@github.com:ory/ory/ cli.git
270+ git clone git@github.com:ory/cli.git
219271
220272# Next you add a git remote that is your fork:
221- git remote add fork git@github.com:< YOUR-GITHUB-USERNAME-HERE> /ory/cli .git
273+ git remote add fork git@github.com:< YOUR-GITHUB-USERNAME-HERE> /.git
222274
223275# Next you fetch the latest changes from origin for master:
224276git fetch origin
0 commit comments