From 904f87c0b50150df7051aa9badbd5258521222b9 Mon Sep 17 00:00:00 2001 From: EXtremeExploit Date: Thu, 12 Jun 2025 16:35:23 -0300 Subject: [PATCH] Add Contribution Guidelines The guidelines come from metux's heads up mail: https://www.freelists.org/post/xlibre/Heads-up-branch-changes-and-MR-policies Signed-off-by: EXtremeExploit --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5640ebf4e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contribution Guidelines + +1. All commits need a sign-off by the author (except for drafts) + If additional reviewers gave their ack, a proper attribution + header may be added. + +2. Commit messages should explain what's really done here and their + headlines need a short an precise subject. See history for examples. + + Keep in mind that history is also a piece of documentation. + +3. Once release is out, bugfixes should be submitted separately, against + the affected release branch(es) as well as master (so multiple MRs) + +4. If new functions or types are introduced, these should be documented + in-code, so we can generate docs directly from the code :) + +5. Use MR tags if you can - if we need some more, just ask.