-
-
Notifications
You must be signed in to change notification settings - Fork 236
docs: add ai policy #821
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
docs: add ai policy #821
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
906d810
docs: add ai policy
steveiliop56 f6e994d
docs: rework ai policy for more clear rules and expectations
steveiliop56 63cc081
chore: review comments
steveiliop56 0a67378
chore: rabbit feedback
steveiliop56 37f927a
chore: update contributing guide to reference ai policy
steveiliop56 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # AI Usage Policy | ||
|
|
||
| > [!NOTE] | ||
| > By Tinyauth, we refer to the entire Tinyauth ([tinyauthapp](https://github.com/tinyauthapp)) organization and all of the repositories under it. | ||
|
|
||
| ## How we utilize AI in Tinyauth | ||
|
|
||
| In Tinyauth, we see AI as another tool designed to help developers accelerate their work, ***not*** as something that should be doing the development for them. The ways we utilize large language models in Tinyauth are the following: | ||
|
|
||
| - **Pull request reviews**: We utilize [Coderabbit](https://www.coderabbit.ai/) for reviews in our pull requests which helps us find and fix issues faster, minimizing the time maintainers have to spend reviewing. | ||
| - **Documentation and Issues**: We use [Dosu](https://dosu.dev/) to help resolve duplicate issues faster and automatically update our documentation based on changes in the code base. | ||
| - **In-Line Suggestions**: GitHub's [Copilot](https://github.com/features/copilot) is partially used to fill in boilerplate code through in-line suggestions. | ||
|
|
||
| ## How we expect the community to use AI | ||
|
|
||
| We expect the Tinyauth community to use AI as a tool for faster development and not as a way to implement entire features through prompts. For this reason, the following guidelines are in place for AI generated content: | ||
|
|
||
| - **All usage must be clearly labeled**: Any content generated by AI must be clearly labeled as such. In case a pull request is clearly generated by AI and the author fails to disclose its use, it will be rejected. | ||
|
steveiliop56 marked this conversation as resolved.
Outdated
|
||
| - **All generated content should be completely understood by the account holder**: The human who utilized the large language model to generate content must have a thorough understanding of it. This includes understanding the resulting output to the full extend and being able to explain it in detail in case it's needed. | ||
|
steveiliop56 marked this conversation as resolved.
Outdated
|
||
| - **Automated systems are not allowed**: All forms of automated systems that utilize large language models to generate content without human oversight are forbidden. This includes any system that generates content without a human being directly involved in the process like for example with OpenClaw. | ||
| - **No generated content other than text is allowed**: The only type of content that can be generated by AI and used in Tinyauth is text. Any other type of content generated by AI cannot be used as it cannot be licensed. | ||
|
steveiliop56 marked this conversation as resolved.
Outdated
|
||
| - **AI pull requests are not guaranteed to be accepted or prioritized**: Any pull request that contains AI generated content is not guaranteed to be accepted and/or prioritized. The maintainers are responsible for reviewing all pull requests and determining whether or not they meet the standards of the project. AI generated content will be reviewed with the same standards as any other content, and may be rejected if it does not meet those standards. | ||
| - **Large generated pull requests will be rejected**: Any pull request that contains a large amount of generated content will be rejected. This is because it is difficult for the maintainers to review and verify large amounts of generated content. | ||
|
|
||
| ## Tinyauth is developed by humans, for humans | ||
|
|
||
| Please remember that Tinyauth is developed by humans. While AI can be a useful tool for **assisting** in the development process, it should not be used in place of the human brain. Moving forward, we are committed to ensuring that most, if not all the content in Tinyauth is created and reviewed by humans, and that AI is only used as a tool to assist in the development process. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.