docs: add description for commit message format

Festo-se / cyclonedx-editor-validator

Tool for creating, modifying and validating CycloneDX SBOMs.

https://festo-se.github.io/cyclonedx-editor-validator/

GNU General Public License v3.0

16 stars 4 forks source link

docs: add description for commit message format #181

Closed italvi closed 2 months ago

github-actions[bot] commented 2 months ago

Coverage Report •

File	Stmts	Miss	Cover	Missing
TOTAL	1598	66	95%

report-only-changed-files is enabled. No files were changed during this commit :)

Tests	Skipped	Failures	Errors	Time
283	2 :zzz:	0 :x:	0 :fire:	4.485s :stopwatch:

mmarseu commented 2 months ago

I've frequently struggled myself with these types of changes. Can we be more precise which type corresponds to a change of a functionality that doesn't truly introduce a new feature but isn't a bugfix either? I assume it would be feat, right?

Other than that, I propose to shorten it a little and move the format to the top, above the definition of type and subject. Want me to commit a proposal?

Edit: Also, we should probably mention that PR titles must follow the same format.

italvi commented 2 months ago

@mmarseu If I understand your question correctly, I would say: no. As your changes maybe adjust the usage but do not add any new functionality, I would use refactor.

I removed the intro and moved the content up + added to use the same format for titles. Does this work for you?