Update AI usage guidelines
All checks were successful
Builds / ExectOS WebSite (push) Successful in 31s

This commit is contained in:
2026-07-19 12:30:11 +02:00
parent eaac50b4eb
commit 05870b6130

View File

@@ -3,27 +3,44 @@ title = 'AI-Assisted Contributions'
date = 2025-07-17T19:44:12+02:00 date = 2025-07-17T19:44:12+02:00
+++ +++
This project includes content and code that has been partially created or assisted by artificial intelligence (AI) tools. This project includes content and code that has been partially created or assisted by artificial intelligence (AI) tools.
We firmly believe that in modern software development, Large Language Models (LLMs) are simply standard working tools,
much like an IDE, a debugger, or a compiler.
### Tools We Use It is important to note that most code in this project is written by hand by our developers. AI does not build this
We actively use the following AI tools to support development and documentation workflows: project for us. It serves as a highly capable assistant that streamlines our workflow.
* **ChatGPT**: for generating and reviewing code, technical writing, and problem-solving assistance.
* **Gemini Assistant**: integrated with VS Code, used for code suggestions and refactoring.
* **GitHub Copilot**: provides real-time code suggestions and completions.
* **Windsurf**: VS Code extension that helps streamline repetitive coding tasks.
We are also experimenting with other AI-based tools to evaluate their usefulness in different areas of the project.
### Human Review ### Our Tooling Approach
All AI-assisted contributions are reviewed and validated by human developers before being committed to the project. We ensure Rather than tying ourselves to a specific set of commercial products, we utilize a diverse of AI tools tailored to our
that any code, documentation, or design produced with AI meets our quality and security standards. current needs. Depending on the complexity of the task and privacy considerations, our toolchain ranges from locally
hosted LLMs (such as Qwen) to advanced, cloud-based frontier models like GPT, GLM, Gemini, or Claude Opus.
### How We Use LLMs
Our primary use cases for AI assistance include:
* **Code Documentation**: Generating clear, comprehensive documentation and comments for complex functions and
architectural components.
* **Code Verification**: Scanning existing codebases to spot potential vulnerabilities, edge cases, or logic errors.
* **Debugging & Analysis**: Assisting in the deep analysis of complex bugs, crash dumps, and unexpected behaviors.
* **Clean-Room Reverse Engineering**: Acting as an invaluable resource for analyzing disassembly, understanding
undocumented behaviors, and explaining obscure instruction sets without compromising clean-room principles.
* **Code Porting**: Translating and porting small code snippets between different hardware architectures.
* **Test Generation**: Creating test cases, such as designing comprehensive edge-case tests for newly written kernel
functions.
* **Documentation Analysis**: Quickly extracting key information and finding answers to specific questions from extensive
technical documentation and hardware specifications, bypassing the need to manually dig through multi-page manuals.
### Why Use AI? ### Why Use AI?
Using AI tools allows us to: By incorporating AI into our daily workflow, we are able to:
* Accelerate development and reduce boilerplate * Accelerate development by significantly reducing boilerplate code.
* Improve consistency in code and documentation * Ensure a higher level of consistency across both code and documentation.
* Explore alternative solutions more efficiently * Efficiently explore alternative architectural solutions and algorithms.
* Focus developer time on complex or creative tasks * Free up valuable developer time to focus on truly complex, creative, and critical problem-solving.
### Human Review & Quality Assurance
While AI is a powerful assistant, it is not infallible. All AI-assisted contributions, whether code, documentation, or
design ideas, are strictly reviewed and validated by human maintainers before being merged into the project. We ensure
that every contribution meets our rigorous quality, architectural, and security standards.
### Transparency & Ethics ### Transparency & Ethics
We are committed to transparent and responsible use of AI. Our goal is to ensure that AI supports - but never replaces - We are committed to the transparent and responsible use of AI. Our ultimate goal is to ensure that AI supports - but never
thoughtful human contribution. If you have any questions or concerns about the role of AI in this project, please open an replaces - thoughtful human contribution and engineering ingenuity. If you have any questions or concerns about the role
issue or contact the maintainers. of AI in this project, please feel free to open an issue or reach out to the maintainers directly.