From 6ff4ba00d783e1535098d325c98133bf5716e170 Mon Sep 17 00:00:00 2001 From: Ilario Gelmetti Date: Tue, 1 Sep 2026 14:02:25 +0200 Subject: [PATCH 1/3] chore: fix broken link in contributing.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f053d203..06ecdf99d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -174,4 +174,4 @@ changes and indicate that the PR is ready to be merged. ### More Information -For more information, please see [Collaborating on projects using issues and pull requests](https://help.github.com/categories/collaborating-on-projects-using-issues-and-pull-requests/) in the GitHub help guide. +For more information, please see [Quickstart for pull requests](https://docs.github.com/en/pull-requests/get-started/pull-request-quickstart) in the GitHub documentation. From b1053ebbd6658bc312a2ec3a5cf9ba34578c0dcb Mon Sep 17 00:00:00 2001 From: Ilario Gelmetti Date: Tue, 1 Sep 2026 14:30:23 +0200 Subject: [PATCH 2/3] feat: guidelines on AI-LLM usage --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06ecdf99d..a9c53fb0c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,40 @@ email, or any other method before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project. + +## How to use AI to contribute + +Artificial Intelligence tools, like LLM and coding assistants, can be used for contributing to the +LibreMesh project but we ask you to respect the following requirements: + +### Be honest and transparent, tell us how much you used AI for your contribution + +It is not the same to review a human-written contribution or a LLM-written one. +Humans make typos and small mistakes, while LLM make conceptual errors, useless tests and +duplicated code. +For helping the code review process, we ask you to disclose if, how much and which AI-LLM you used +(e.g., "I used XYZ for writing the code but then I checked every detail myself"). + +### Make sure you learn something + +LibreMesh is about empowering communities giving them an easy to use tool for creating mesh +networks. But it is also about allowing users to get empowered becoming developers. +When you contribute, make sure you understand what you are doing and learn something new. +If you cannot understand what AI wrote, ask for help in the +[LibreMesh communication channels](https://github.com/libremesh/lime-packages/tree/master#get-in-touch-with-libremesh-community). + +### Be critical, check the code with your own brain + +As mentioned above, LLM can make conceptual errors and write useless or duplicate code. +Please use your own judgment and properly check the code before submitting it for review. + +### Take responsibility + +When you submit some code, we will assume that you thoroughly checked the code and tested it +in a virtual machine or on a real device. If AI makes bad code, either improve it yourself +or avoid contributing it. + + ## Forks and Pull Requests Development on lime-packages follows the Fork and Pull Request method popularized by GitHub: From 33bd264e47b6baff0d67b5ea81a5076f32a353f2 Mon Sep 17 00:00:00 2001 From: Ilario Gelmetti Date: Sat, 5 Sep 2026 10:55:15 +0200 Subject: [PATCH 3/3] contributing.md: add content (Gothos feedback) --- CONTRIBUTING.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a9c53fb0c..e92192edf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,8 +8,10 @@ Please note we have a code of conduct, please follow it in all your interactions ## How to use AI to contribute -Artificial Intelligence tools, like LLM and coding assistants, can be used for contributing to the -LibreMesh project but we ask you to respect the following requirements: +We do not explicitly encourage the employment of Artificial Intelligence tools, like LLM and +coding assistants. But we do not forbid it neither, and we will not discard contributions made +using AI-LLM tools. You can use such tools for contributing to the LibreMesh project respecting +the following requirements: ### Be honest and transparent, tell us how much you used AI for your contribution @@ -30,13 +32,14 @@ If you cannot understand what AI wrote, ask for help in the ### Be critical, check the code with your own brain As mentioned above, LLM can make conceptual errors and write useless or duplicate code. -Please use your own judgment and properly check the code before submitting it for review. +Please use your own judgment and properly check the code. Then execute the code on your host or +router or virtual machine before submitting it for review. ### Take responsibility -When you submit some code, we will assume that you thoroughly checked the code and tested it +When you submit some code, we will assume that you thoroughly checked and tested it in a virtual machine or on a real device. If AI makes bad code, either improve it yourself -or avoid contributing it. +or avoid contributing it. Respect the opinion of the reviewers even if AI disagrees. ## Forks and Pull Requests