From cad2c7faa320883b7a66189745bb20933a039d04 Mon Sep 17 00:00:00 2001 From: Awiteb Date: Thu, 22 May 2025 08:26:33 +0000 Subject: [PATCH] chore: Update `CONTRIBUTING.md` Signed-off-by: Awiteb --- CONTRIBUTING.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29a6aa8..0d7b024 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,22 @@ Before submitting changes, please read the [Developer Certificate of Origin](DCO All patches must include a `Signed-off-by: NAME ` line to acknowledge your agreement with the DCO. +Ensure your Git name and email are correctly configured. While you don’t need to +use your real details, avoid leaving them as the default values. To verify your +current settings, run: + +```bash +git config user.name +git config user.email +``` + +If they’re incorrect or unset, update them using: + +```bash +git config --global user.name "Your Name" +git config --global user.email "your.email@example.com" +``` + We welcome all contributions, whether it be bug reports, fixes, feature submissions, feature requests, or improving documentation or testing. Enjoy collaborating! @@ -49,6 +65,9 @@ to their read relays, most tools handle this automatically. #### Patch Guidelines - Keep patches small: Focused changes are easier to review and merge. +- Run `just ci` before submitting your patch. +- Update the change log with your patch. Run `just changelog` or `git-cliff > CHANGELOG.md` +- Add your name to the [AUTHORS](AUTHORS) file if this is your first contribution. (alphabetical order) - Use [Conventional Commits]: Start the patch subject with one of these types: - `feat`: New feature - `fix`: Bug fix @@ -62,7 +81,6 @@ to their read relays, most tools handle this automatically. - For all other changes, use `chore`. - Add `!` to the subject if your patch contains a breacking change, e.g. `remove!: text` and `fix(reply)!: text` -- Run `just ci` before submitting your patch. #### Code Style