Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: explain stgit.autosign a bit better #515

Merged
merged 1 commit into from
Dec 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ following guidelines:
certifies that you wrote or otherwise have the right to contribute the
patch as open-source, according to the [Developers Certificate of
Origin](#developers-certificate-of-origin-11). A `Signed-off-by:` line
can be added to a patch by running `stg edit --sign`.
can be added to a patch by running `stg edit --sign`, and you can add one to
new patches by default with the setting by setting the config
`stgit.autosign` to `Signed-off-by`.

- Lint. Run `make lint` to ensure that the code meets the project's
syntactic standards and passes static checks.
Expand Down
6 changes: 4 additions & 2 deletions Documentation/stg.txt
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,10 @@ stgit.autoimerge::
is automatically run to attempt to resolve the conflicts.

stgit.autosign::
Automatically add "Signed-off-by:" trailer to commit messages for new patches created
with linkstg:new[] or lingstg:import[].
Automatically add signoff trailer to commit messages for new patches created
with linkstg:new[] or lingstg:import[]. The value of this configuration
variable will be used as the key of the trailer and therefore should be set
to something like 'Signed-off-by'.

stgit.autostash::
When running linkstg:rebase[], if any modified files are found in the working tree, a
Expand Down
Loading