Repository navigation
docs: use a more strict ai policy #1238
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
+75
−36
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b6ad12a
docs: use a more strict ai policy
steveiliop56 9703686
docs: forbid the use of co-developed-by trailers
steveiliop56 43ffcd2
chore: minor improvements and add CLAUDE.md file
steveiliop56 c82a559
chore: fix broken links
steveiliop56 157711f
chore: fix typo
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
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 |
|---|---|---|
| @@ -1,27 +1,68 @@ | ||
| # AI Usage Policy | ||
| # AI Policy | ||
|
|
||
| > [!NOTE] | ||
| > By Tinyauth, we refer to the entire Tinyauth ([tinyauthapp](https://github.com/tinyauthapp)) organization and all of the repositories under it. | ||
| > By Tinyauth, we refer to the entire Tinyauth ([tinyauthapp](https://github.com/tinyauthapp)) organization and all the repositories under it. | ||
|
|
||
| ## How we utilize AI in Tinyauth | ||
| At Tinyauth, we believe that LLMs (Large Language Models) can help speed up development given that they are used correctly. However, we are strictly against generated output with little to no human oversight. | ||
|
|
||
| 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: | ||
| ## How we use LLMs in Tinyauth | ||
|
|
||
| - **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. | ||
| ### Code reviews | ||
|
|
||
| ## How we expect the community to use AI | ||
| We use [CodeRabbit](https://www.coderabbit.ai/) for automated reviews that can help catch bugs early. | ||
|
|
||
| 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: | ||
| ### In-line suggestions | ||
|
|
||
| - **All usage must be clearly labeled**: Any content generated by AI must be clearly labeled as such. In the case that a pull request is clearly generated by AI and the author fails to disclose its use, it will be rejected. | ||
| - **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 extent and being able to explain it in detail in case it's needed. | ||
| - **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**: Images, videos, audio and any other form of content generated by AI other than text is not allowed in Tinyauth. | ||
| - **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. | ||
| In-line suggestions are a huge part of the development workflow because they essentially provide faster and more accurate IntelliSense. | ||
|
|
||
| ## Tinyauth is developed by humans, for humans | ||
| ### Sporadic LLM assisted development | ||
|
|
||
| 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. | ||
| We may use LLMs to help extend our testing suite or write initial code prototypes. However, we never merge code not fully understood by a human. | ||
|
|
||
| When we use an LLM to write any part of the code, we take full responsibility of the generated output. Thus, we are against the use of trailers like `co-developed` or `assisted-by` as an LLM cannot be held accountable for its generated code. | ||
|
|
||
| ## How we expect the community to use LLMs | ||
|
|
||
| We expect the community to use LLMs in the same way we do, responsibly. We previously tried using more lax measures for LLM usage, but it seems like our instructions were ignored. | ||
|
|
||
| We don't have the bandwidth nor the time to triage and review slop pull requests/issues/security advisories/etc. If you didn't bother putting your time in a contribution, why should we put ours reviewing it? | ||
|
|
||
| That's why the following measures are in place. | ||
|
|
||
| ### LLM disclosure is required | ||
|
|
||
| Every time an LLM is used, its usage should be disclosed. We provide relevant check boxes for disclosing the use of LLMs when creating an issue or a pull request. | ||
|
|
||
| As mentioned above, trailers like `co-developed` or `assisted-by` are **forbidden**. When you use an LLM for code generation, you **must** take full accountability of the code. We cannot hold an LLM accountable for broken code. | ||
|
|
||
| We will **not** accept any contributions pretending that they were written by a human while the code is clearly generated. | ||
|
|
||
| Security advisories should disclose their usage by checking the LLM usage checkbox. | ||
|
|
||
| ### Human written descriptions are required | ||
|
|
||
| A human should write every part of the issue, pull request, security advisory or anything that interacts with our community. | ||
|
steveiliop56 marked this conversation as resolved.
Resolved
|
||
|
|
||
| We are all humans, we don't care about typos or grammar errors. We prefer English with honest mistakes rather than slop essays. | ||
|
|
||
| If you use an LLM for translation purposes, you **must** include the original description in the original language to follow the "written by a human" rule. | ||
|
|
||
| Every type of interaction that's not written by a human will be **ignored**. | ||
|
|
||
| ### You are required to fully understand the output of the LLM | ||
|
|
||
| Reviewing takes time, when we review and comment on your pull request, issue or security advisory, we expect a human to be located behind the keyboard and be in a position to explain the code or the thought process behind every single line of code. | ||
|
|
||
| Don't copy and paste our comments to an LLM, we can do that ourselves. | ||
|
|
||
| ### Only text is allowed | ||
|
|
||
| We cannot accept material such as pictures or audio because of multiple cases of them violating copyright infringement laws. | ||
|
|
||
| ### Automated systems are not allowed | ||
|
|
||
| We are not a testing playground for agent harnesses such as OpenClaw or Hermes. If we notice any kind of unapproved automated system interacting with our repositories, it will be **immediately banned** with **no warning**. | ||
|
|
||
| Automated systems that we have approved, such as CodeRabbit and the agents described in `AGENTS.md`, are exempt. | ||
|
|
||
| These are not suggestions, they are **rules** for interacting with the Tinyauth organization. If you violate them, your contribution will be **ignored**. Repeat offenders will be **banned**. | ||
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 @@ | ||
| @AGENTS.md |
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
Oops, something went wrong.
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.