From 5c59b97aa2f3f6773c7d4e0d05c37ee1dace0161 Mon Sep 17 00:00:00 2001 From: Rodrigo Arias Mallo Date: Fri, 27 Mar 2026 12:43:32 +0100 Subject: [PATCH] Add contributing guidelines MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Regulate git commit style and ban LLM usage. Reviewed-by: Aleix Roca Nonell Reviewed-by: Aleix Boné --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d461632f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing guidelines for jungle + +We welcome contributions from other people, provided that they follow these +guidelines. + +## Git commit rules + +The commit title must be strictly 50 character or less, the commit body must +wrap at 72 characters. + +Every commit to be merged in master must be reviewed by at least one other +member and have the corresponding `Reviewed-by: John Doe ` git +trailer with their name and email. + +Commits that fix a particular issue must include the **full URL** to the issue +in the `Fixes: ` trailer. + +## LLM are banned + +Contributions generated fully or partially by LLMs won't be accepted, you must +write the code yourself and fully understand what every part does. + +Using LLMs to help preparing a contribution is strongly discouraged, as it will +likely cause you to have gaps of understanding. diff --git a/README.md b/README.md index 50cc8fd3..236b0699 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,5 @@ This repository provides two components that can be used independently: - NixOS configurations for jungle machines. Use `nixos-rebuild switch --flake .` to upgrade the current machine. + +Before contributing, please read the [guidelines](CONTRIBUTING.md).