Skip to content

Fix signing command in contribution guide#943

Merged
jkowalleck merged 1 commit intoCycloneDX:mainfrom
stefan6419846:signoff
Mar 6, 2026
Merged

Fix signing command in contribution guide#943
jkowalleck merged 1 commit intoCycloneDX:mainfrom
stefan6419846:signoff

Conversation

@stefan6419846
Copy link
Contributor

Description

The correct parameter name is --signoff as per the official docs: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s Otherwise, it is frustrating for occasional or first-time contributors to be told to use parameters which the standard tools do not understand.

Additionally fixes a casing typo I stumbled upon when reading the document.

Resolves or fixes issue: none

AI Tool Disclosure

  • My contribution does not include any AI-generated content
  • My contribution includes AI-generated content, as disclosed below:
    • AI Tools: [e.g. GitHub CoPilot, ChatGPT, JetBrains Junie etc.]
    • LLMs and versions: [e.g. GPT-4.1, Claude Haiku 4.5, Gemini 2.5 Pro etc.]
    • Prompts: [Summarize the key prompts or instructions given to the AI tools]

Affirmation

The correct parameter name is `--signoff` as per the official docs: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s

Additionally fixes a casing typo I stumbled upon when reading the
document.

Signed-off-by: stefan6419846 <96178532+stefan6419846@users.noreply.github.com>
@stefan6419846 stefan6419846 requested a review from a team as a code owner March 5, 2026 16:20
@read-the-docs-community
Copy link

Documentation build overview

📚 CycloneDX Python Library | 🛠️ Build #31680312 | 📁 Comparing c3a9b09 against latest (bf596c0)


🔍 Preview build

Show files changed (9 files in total): 📝 9 modified | ➕ 0 added | ➖ 0 deleted
File Status
contributing.html 📝 modified
genindex.html 📝 modified
autoapi/cyclonedx/serialization/index.html 📝 modified
autoapi/cyclonedx/exception/output/index.html 📝 modified
autoapi/cyclonedx/exception/serialization/index.html 📝 modified
autoapi/cyclonedx/output/json/index.html 📝 modified
autoapi/cyclonedx/output/xml/index.html 📝 modified
autoapi/cyclonedx/validation/json/index.html 📝 modified
autoapi/cyclonedx/contrib/license/exceptions/index.html 📝 modified

@jkowalleck jkowalleck added the documentation Improvements or additions to documentation label Mar 6, 2026
@jkowalleck jkowalleck merged commit 44f1273 into CycloneDX:main Mar 6, 2026
4 checks passed
@stefan6419846 stefan6419846 deleted the signoff branch March 6, 2026 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants