From f25ff6b6b764ae9b794a54c282a72ccf7e7420a2 Mon Sep 17 00:00:00 2001 From: Vitor Henrique Date: Wed, 14 Feb 2024 16:50:17 -0300 Subject: [PATCH] CONTRIBUTING: improve commit message/PR title for script changes --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ee9a1009..b10419a40 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -241,7 +241,10 @@ Where `{{command}}` is the name of the command being modified, and `type of chan - For multiple subcommand page additions: `git-{add, push, ...}: add page` - For modifying multiple pages in a language: `pages./*: update pages` -For script changes, use the format `scripts/{{script_name}}: type of change`. +For script changes, the commit message/PR title can be (but not limited to) one of the following examples: + +- For a script edit: `scripts/set-alias-page: fix performance issue` +- For changes that affect multiple scripts: `scripts: replace insecure library` For other cases, it is suggested to follow as much as possible.