ok/jj
1
0
Fork 0
forked from mirrors/jj
Code Pull requests Activity

docs: clarify that commit messages start with a topic, not a component

Browse source 
It's generally more useful to say something like "revset: use Self to
refer to expressions of the same type" than "lib: use Self to refer to
revset expressions of the same type ", so let's try to clarify that.
This commit is contained in:
Martin von Zweigbergk 2024-10-07 09:26:03 -07:00 committed by Martin von Zweigbergk
parent 9f578c4f10
commit 71b60a3102
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/contributing.md
View file

@ -40,7 +40,7 @@ test and document.
The commit message should describe the changes in the commit; The commit message should describe the changes in the commit;
the PR description can even be empty, but feel free to include a personal the PR description can even be empty, but feel free to include a personal
message. We write commit messages in an affected component style and don't use message. We start the commit message with `<topic>: ` and don't use
[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). This means if [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). This means if
you modified a command in the CLI, use its name as the topic, e.g you modified a command in the CLI, use its name as the topic, e.g
`next/prev: <your-modification>` or `conflicts: <your-modification>`. We don't `next/prev: <your-modification>` or `conflicts: <your-modification>`. We don't