docs(config): document backend.signoff_commits option (DCMS-442) - #2
Open
sempostma wants to merge 1 commit into
Open
docs(config): document backend.signoff_commits option (DCMS-442)#2sempostma wants to merge 1 commit into
sempostma wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the
signoff_commitsbackend config option on the Configuration Options page. This option is fully implemented inpackages/decap-cms-core/src/lib/formatters.ts(commitMessageFormatter, decap-cms repo) — it appends a git-styleSigned-off-by: {name} <{email}>trailer to every generated commit message when enabled — but was never documented on decapcms.org.Adds a new "Sign Off Commits" subsection under Backend > Commit Message Templates, documenting:
boolean) and default (false)Fixes DCMS-442. Issue:
/Users/sempostma/Documents/personal/Projects/decap-cms/Issues/DCMS-442 - backend.signoff_commits config option implemented (adds Signed-off-by trailer) but not documented on decapcms.org Configuration Options page.mdTest plan
commit_messagessection for style/formatting consistencyhugonot installed locally; repo's ownlintscript only covers layouts/eslint/scss, not markdown content — no applicable lint/build gate found