docs(commit): add multiline option `questions` content table

commitizen-tools / commitizen

Create committing rules for projects :rocket: auto bump versions :arrow_up: and auto changelog generation :open_file_folder:

MIT License

2.55k stars 266 forks source link

Description

I suggest to mention the multline support for input question in the documentation since it is already supported and a multiline description in the body is essential for good commits

Checklist

[ ] Add test cases to all the changes you introduce
[ ] Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
[ ] Test the changes on the local machine manually
[x] Update the documentation for the changes

Expected behavior

Question type = input and option multiline = True, multiline input is possible

Steps to Test This Pull Request

created .cz.yaml and added the option multiline: true to the question type: text and type: input
in https://github.com/commitizen-tools/commitizen/issues/264#issuecomment-1620234279 marcosdotme tested it in toml and reported it works

Additional context

Closes: https://github.com/commitizen-tools/commitizen/issues/264

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.63%. Comparing base (120d514) to head (eea0eb4). Report is 468 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #1265 +/- ## ========================================== + Coverage 97.33% 97.63% +0.29% ========================================== Files 42 55 +13 Lines 2104 2575 +471 ========================================== + Hits 2048 2514 +466 - Misses 56 61 +5 ``` | [Flag](https://app.codecov.io/gh/commitizen-tools/commitizen/pull/1265/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/commitizen-tools/commitizen/pull/1265/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) | `97.63% <ø> (+0.29%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#carryforward-flags-in-the-pull-request-comment) to find out more.

commitizen-tools / commitizen