ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING: improve commit message/PR title for script changes

pull/23/head
Vitor Henrique 2024-02-14 16:50:17 -03:00 committed by K.B.Dharun Krishna
parent e75532952a
commit f25ff6b6b7
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -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.<locale>/*: 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 <https://www.conventionalcommits.org/> as much as possible.