Skip to content

Commit 44f1273

Browse files
Fix signing command in contribution guide (#943)
<!--🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅 You can expedite processing of your PR by using this template to provide context and additional information. Before actually opening a PR please make sure that it does NOT fall into any of the following categories 🚫 Spam PRs (accidental or intentional) - these will result in a 30-days or even ∞ ban from interacting with the project depending on reoccurrence and severity. 🚫 Lazy typo fixing PRs - if you fix a typo in a file, your PR will only be merged if all other typos in the same file are also fixed with the same PR 🚫 If you fail to provide any _Description_ below, your PR will be considered spam. If you do not check the _Affirmation_ box below, your PR will not be merged. 🚫 If you do not check one of the _AI Tool Disclosure_ boxes below, your PR will not be merged. If you used AI tools to assist you in writing code, but fail to provide the required disclosure, your PR will not be merged. 🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅--> ### 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 - [x] 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 - [x] My code follows the [CONTRIBUTING.md](https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/CONTRIBUTING.md) guidelines Signed-off-by: stefan6419846 <96178532+stefan6419846@users.noreply.github.com>
1 parent bf596c0 commit 44f1273

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ poetry install --all-extras
2121

2222
## Code style
2323

24-
THis project loves latest python features.
24+
This project loves latest python features.
2525
This project loves sorted imports.
2626
This project uses [PEP8] Style Guide for Python Code.
2727

@@ -67,7 +67,7 @@ Please sign off your commits, to show that you agree to publish your changes und
6767
, and to indicate agreement with [Developer Certificate of Origin (DCO)](https://developercertificate.org/).
6868

6969
```shell
70-
git commit --signed-off ...
70+
git commit --signoff ...
7171
```
7272

7373
## Pre-commit hooks

0 commit comments

Comments
 (0)