Skip to content

longer description shouldn't be truncated to 100char limit #4

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.

Sign up for GitHub

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

Jump to bottom
Closed
rbutera opened this issue Apr 28, 2015 · 6 comments
Closed

longer description shouldn't be truncated to 100char limit #4

rbutera opened this issue Apr 28, 2015 · 6 comments
Labels
adapter bug

Comments

@rbutera
Copy link

rbutera commented Apr 28, 2015

there's no point in having a 'longer description' if it is forced to be the same length as the short description.
@jimthedev
Copy link
Member

Hi @raibutera. Thanks for the feedback. I'm assuming that you're referring to the body line mentioned here: https://github.com/ajoslin/conventional-changelog/blob/master/CONVENTIONS.md and that it is limited to 100 characters.

As you can see, the conventional commit format dictates that any line should actually be limited to 100 characters, so we're just following the spec for now. You can remove this restriction by forking https://github.com/commitizen/cz-conventional-changelog and publishing your own adapter. You'd just edit the following line to remove the splice: https://github.com/commitizen/cz-conventional-changelog/blob/master/index.js#L80

I'm going to close this for now but if you feel we're misinterpreting the spec then please feel free to let me know.

@rbutera
Copy link
Author

rbutera commented Apr 30, 2015

Jim, I do believe you are misinterpreting the specification.

"Any line of the commit message cannot be longer 100 characters! This
allows the message to be easier to read on github as well as in various git
tools."

The 100-character limit is PER LINE, not per SECTION. The body section can
comprise multiple LINES. In fact, it SHOULD (to preserve readability, as
per the justification of the limitation, ie. 'Allows the message to be
easier to read....').

tl;dr:

  1. the 100 character limit is per line
  2. the 100 character limit is for readability
  3. applying the 100 character limit to each SECTION makes the body line
    redundant (how can a more verbose body be achieved with the same characters
    as the 'short' description?)
  4. the point of the body section is to be verbose
  5. look at angular commits, the body section is often longer than 100
    characters.

Sorry for being blunt etc, I'm on mobile.

On Thu, 30 Apr 2015 at 21:46, Jim Cummins [email protected] wrote:

Closed #4 #4.

—
Reply to this email directly or view it on GitHub
#4 (comment).

@jimthedev
Copy link
Member

No problem about mobile bluntness. I understand. Sorry for my late reply. ;)  

You are indeed correct. So, rather than limiting the body field to 100 characters, we should do word wrapping for people at 100 characters but ultimately the field should be unlimited in length, correct? And the same would go for the footer which can be multiple lines and unlimited in length.

Does that sound right?

Jim

@jimthedev jimthedev reopened this Apr 30, 2015
@jimthedev
Copy link
Member

Quick update on this. I have a branch that works properly pending a gulp-git pull request that includes some fixes for multi-line commits. Once that is released I'll release the new version of the cz-cli and cz-conventional-changelog adapter.

@jimthedev
Copy link
Member

Please note that this is fixed in the adapter code in cz-conventional-changelog version 1.1.0 but in order to work properly it will still need a cli fix that is pending due to my gulp-git PR listed above.

jimthedev added a commit that referenced this issue May 7, 2015
@jimthedev
fix(wrapping): Fix fields to wrap instead of truncate at 100 characters
f637e2d 
Fields should not be truncated at 100 characters. Instead, they should wrap. The exception is the
first, or summary line of the commit message which is truncated to 100 characters since it is a
summary.

This closes #4
@jimthedev
Copy link
Member

This was released in 1.0.4.

simon-watiau pushed a commit to simon-watiau/cz-conventional-changelog that referenced this issue Apr 7, 2019
@jimthedev @simon-watiau
fix(wrapping): Fix fields to wrap instead of truncate at 100 characters
7257bf2 
Fields should not be truncated at 100 characters. Instead, they should wrap. The exception is the

first, or summary line of the commit message which is truncated to 100 characters since it is a

summary.

This closes commitizen/cz-cli#4
cenk1cenk2 added a commit to cenk1cenk2/cz-cc that referenced this issue Jul 26, 2020
@cenk1cenk2
chore(release): 1.0.0 - 20200726 [skip ci]
a97fcb0 
# 1.0.0 (2020-07-26)

### Bug Fixes

* clean up readme ([cf3be63](cf3be63))
* remove dist with ignore ([ccd39c6](ccd39c6))
* **adapter:** Fix typo in etc. ([39182b8](39182b8))
* **build:** Add proper deps, force republish to make sure things are working ([922097b](922097b))
* **build:** Automatic releases!!! ✨ ([114f967](114f967))
* **commit:** Remove es6 string syntax (backticks) ([7f922f2](7f922f2))
* **commit:** remove parentheses when there is no scope present ([55f72b9](55f72b9))
* **config-loader:** captured the direct dependency on commitizen for the use of the config loader ([#90](#90)) ([4b23bbc](4b23bbc)), closes [#89](#89)
* **defaultValues:** Added fallback for optional default values ([#99](#99)) ([2aae317](2aae317))
* **internal:** adding a commit ([f867794](f867794))
* **prompter:** resolve issue with new inquirer api ([#18](#18)) ([807b4e5](807b4e5))
* **require:** get rid of relative path to the word-wrap ([e98818a](e98818a)), closes [#4](#4)
* **scope:** test ([e0bd9f9](e0bd9f9))
* description ([7e90934](7e90934))
* **some-scope:** test fix ([0ea207e](0ea207e))
* remove pre-node 10 support ([#86](#86)) ([76588ad](76588ad))
* Update conventional-commit-types to the latest version 🚀 ([#105](#105)) ([5a371c1](5a371c1))
* update longest to ^2 ([#88](#88)) ([7234529](7234529))
* **wrapping:** Fix fields to wrap instead of truncate at 100 characters ([c7b7e11](c7b7e11)), closes [commitizen/cz-cli#4](commitizen/cz-cli#4)

### Features

* **engine:** add support for disableScopeLowerCase ([#96](#96)) ([e7bd546](e7bd546))
* **types:** add suport for custom types ([#104](#104)) ([aae2548](aae2548))
* add default values to options ([#69](#69)) ([65d6a9f](65d6a9f))
* implement configuration through package.json ([#75](#75)) ([3398c02](3398c02))
* **adapter:** Create initial commit. ([4e8da01](4e8da01))
* **adapter:** refactor to engine, default to conventional commit types ([c8452d1](c8452d1)), closes [#29](#29)
* **adapter:** Split breaking changes into separate question ([#44](#44)) ([2d78e1d](2d78e1d)), closes [#17](#17)
* **prompt:** add confirmation fields + edit for clarity ([#58](#58)) ([d40ac2c](d40ac2c)), closes [#52](#52)

### BREAKING CHANGES

* some changes more
* Node 10 is LTS so please upgrade to it.
* **adapter:** Breaking changes now automatically include the "BREAKING CHANGE: " prefix.
github-actions bot pushed a commit to DawChihLiou/cz-conventional-changelog-with-jiraid-detection that referenced this issue Sep 16, 2020
@semantic-release-bot
chore(release): 1.0.0 [skip ci]
e10c25d 
# 1.0.0 (2020-09-16)

### Bug Fixes

* **adapter:** Fix typo in etc. ([39182b8](39182b8))
* **build:** Add proper deps, force republish to make sure things are working ([922097b](922097b))
* **build:** Automatic releases!!! ✨ ([114f967](114f967))
* update longest to ^2 ([commitizen#88](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/88)) ([7234529](7234529))
* **commit:** Remove es6 string syntax (backticks) ([7f922f2](7f922f2))
* **commit:** remove parentheses when there is no scope present ([55f72b9](55f72b9))
* **config-loader:** captured the direct dependency on commitizen for the use of the config loader ([commitizen#90](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/90)) ([4b23bbc](4b23bbc)), closes [commitizen#89](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/89)
* **defaultValues:** Added fallback for optional default values ([commitizen#99](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/99)) ([2aae317](2aae317))
* **package.json:** install missing dependency ([4287211](4287211))
* **package.json:** update package name ([2985968](2985968))
* **prompter:** resolve issue with new inquirer api ([commitizen#18](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/18)) ([807b4e5](807b4e5))
* Correct typo in JSON ([58df4d1](58df4d1))
* **release:** attempt to fix release ([c167fd8](c167fd8))
* **release.config.js:** attempt to fix semantic release ([e362f9a](e362f9a))
* **require:** get rid of relative path to the word-wrap ([e98818a](e98818a)), closes [commitizen#4](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/4)
* **wrapping:** Fix fields to wrap instead of truncate at 100 characters ([c7b7e11](c7b7e11)), closes [commitizen/cz-cli#4](commitizen/cz-cli#4)
* remove pre-node 10 support ([commitizen#86](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/86)) ([76588ad](76588ad))
* Update conventional-commit-types to the latest version 🚀 ([commitizen#105](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/105)) ([5a371c1](5a371c1))
* Wrap updateTypes in packageRules ([0f6dfbf](0f6dfbf))

### Features

* **adapter:** Create initial commit. ([4e8da01](4e8da01))
* **adapter:** refactor to engine, default to conventional commit types ([c8452d1](c8452d1)), closes [commitizen#29](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/29)
* **adapter:** Split breaking changes into separate question ([commitizen#44](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/44)) ([2d78e1d](2d78e1d)), closes [commitizen#17](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/17)
* add default values to options ([commitizen#69](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/69)) ([65d6a9f](65d6a9f))
* implement configuration through package.json ([commitizen#75](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/75)) ([3398c02](3398c02))
* **engine:** add support for disableScopeLowerCase ([commitizen#96](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/96)) ([e7bd546](e7bd546))
* **engine:** add support for disableSubjectLowerCase ([df66875](df66875))
* **engine.js:** add jira step ([b6c6bfb](b6c6bfb))
* **prompt:** add confirmation fields + edit for clarity ([commitizen#58](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/58)) ([d40ac2c](d40ac2c)), closes [commitizen#52](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/52)
* **types:** add suport for custom types ([commitizen#104](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/issues/104)) ([aae2548](aae2548))

### BREAKING CHANGES

* Node 10 is LTS so please upgrade to it.
* **adapter:** Breaking changes now automatically include the "BREAKING CHANGE: " prefix.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
adapter bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jimthedev @rbutera