|
1 | | -# Contributing<br>to `readme-inspector` |
| 1 | +# Contributing to `readme-inspector` |
2 | 2 |
|
3 | | -[![PRs Welcome][makeapullrequest-image]][makeapullrequest-url] We welcome contributors, issues, and pull requests. |
| 3 | +> [![PRs Welcome][makeapullrequest-image]][makeapullrequest-url] We welcome contributors, issues, and pull requests. |
| 4 | +> |
| 5 | +> [![Request a feature][issues-new-feat-image]][issues-new-feat-url] [![Report a defect][issues-new-defect-image]][issues-new-defect-url] |
4 | 6 |
|
5 | 7 | ## Table of contents |
6 | 8 |
|
|
113 | 115 |
|
114 | 116 | Go ahead! Get started now: |
115 | 117 |
|
116 | | - * [![Request a feature][issues-new-feat-image]][issues-new-feat-url] |
117 | | - |
118 | | - * [![Report a defect][issues-new-defect-image]][issues-new-defect-url] |
119 | | - |
120 | 118 | * [Review all open issues][issues-url] |
121 | 119 |
|
122 | 120 | * ### 1.2. Format titles with **`type(scope): subject`**. |
|
301 | 299 |
|
302 | 300 | > Consistent, legible Git logs not only facilitate communication, but also enable automated `CHANGELOG` generation and semantic versioning with [`standard-version`][standard-version-url]. |
303 | 301 |
|
| 302 | + *** |
| 303 | + |
| 304 | + <details> |
| 305 | + <summary><strong>View all conventional commit message templates.</strong></summary> |
| 306 | + <p> |
| 307 | + |
| 308 | + * **`BREAKING CHANGE` commit messages** |
| 309 | + |
| 310 | + A change that breaks the product's public API. |
| 311 | + |
| 312 | + ```shell |
| 313 | + <type>(<scope>): <subject> |
| 314 | + <BLANK LINE> |
| 315 | + BREAKING CHANGE: summary of change. |
| 316 | + <BLANK LINE> |
| 317 | + <[body]> |
| 318 | + <BLANK LINE> |
| 319 | + <footer> |
| 320 | + ``` |
| 321 | + |
304 | 322 | * **`build` commit messages** |
305 | 323 |
|
306 | 324 | Issues related to product builds. |
307 | 325 |
|
308 | | - ``` |
| 326 | + ```shell |
309 | 327 | build(<scope>): <subject> |
310 | 328 | <BLANK LINE> |
311 | 329 | <[body]> |
|
317 | 335 |
|
318 | 336 | Issues related to miscellaneous non-functional changes (usually "maintenance" changes). |
319 | 337 |
|
320 | | - ``` |
| 338 | + ```shell |
321 | 339 | chore(<scope>): <subject> |
322 | 340 | <BLANK LINE> |
323 | 341 | <[body]> |
|
329 | 347 |
|
330 | 348 | Issues related to continuous integration, delivery, and deployment tasks. |
331 | 349 |
|
332 | | - ``` |
| 350 | + ```shell |
333 | 351 | ci(<scope>): <subject> |
334 | 352 | <BLANK LINE> |
335 | 353 | <[body]> |
|
341 | 359 |
|
342 | 360 | Issues related to documentation. |
343 | 361 |
|
344 | | - ``` |
| 362 | + ```shell |
345 | 363 | docs(<scope>): <subject> |
346 | 364 | <BLANK LINE> |
347 | 365 | <[body]> |
|
353 | 371 |
|
354 | 372 | New feature or enhancement requests. |
355 | 373 |
|
356 | | - ``` |
| 374 | + ```shell |
357 | 375 | feat(<scope>): <subject> |
358 | 376 | <BLANK LINE> |
359 | 377 | <[body]> |
|
365 | 383 |
|
366 | 384 | Defect (bug) repair issues. |
367 | 385 |
|
368 | | - ``` |
| 386 | + ```shell |
369 | 387 | fix(<scope>): <subject> |
370 | 388 | <BLANK LINE> |
371 | 389 | <[body]> |
|
377 | 395 |
|
378 | 396 | Performance improvement issues. |
379 | 397 |
|
380 | | - ``` |
| 398 | + ```shell |
381 | 399 | perf(<scope>): <subject> |
382 | 400 | <BLANK LINE> |
383 | 401 | <[body]> |
|
389 | 407 |
|
390 | 408 | Source code design **improvements that do not affect product behavior**. |
391 | 409 |
|
392 | | - ``` |
| 410 | + ```shell |
393 | 411 | refactor(<scope>): <subject> |
394 | 412 | <BLANK LINE> |
395 | 413 | <[body]> |
|
403 | 421 |
|
404 | 422 | In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted. |
405 | 423 |
|
406 | | - ``` |
| 424 | + ```shell |
407 | 425 | revert: <hash> |
408 | 426 | <BLANK LINE> |
409 | 427 | This reverts commit <hash>. |
|
415 | 433 |
|
416 | 434 | Issues related to style guideline compliance, especially `ESLint` errors and warnings. |
417 | 435 |
|
418 | | - ``` |
| 436 | + ```shell |
419 | 437 | style(<scope>): <subject> |
420 | 438 | <BLANK LINE> |
421 | 439 | <[body]> |
|
427 | 445 |
|
428 | 446 | Test coverage tasks. |
429 | 447 |
|
430 | | - ``` |
| 448 | + ```shell |
431 | 449 | test(<scope>): <subject> |
432 | 450 | <BLANK LINE> |
433 | 451 | <[body]> |
434 | 452 | <BLANK LINE> |
435 | 453 | <footer> |
436 | 454 | ``` |
437 | 455 |
|
| 456 | + </p> |
| 457 | + </details> |
| 458 | + |
| 459 | + *** |
| 460 | + |
438 | 461 | - #### 2.2.5. Sync with remote to get changes you’ve missed. |
439 | 462 |
|
440 | 463 | ```sh |
|
600 | 623 | | [[email protected]](https://lodash.com/) | The lodash method `_.camelCase` exported as a module. | 4.3.0 | MIT | production | |
601 | 624 | | [[email protected]](https://lodash.com/) | The lodash method `_.mapKeys` exported as a module. | 4.6.0 | MIT | production | |
602 | 625 | | [[email protected]](https://lodash.com/) | The lodash method `_.noop` exported as a module. | 3.0.1 | MIT | production | |
603 | | - | [meow@4.0.0](https://github.com/sindresorhus/meow#readme) | CLI app helper | 4.0.0 | MIT | production | |
| 626 | + | [meow@5.0.0](https://github.com/sindresorhus/meow#readme) | CLI app helper | 4.0.0 | MIT | production | |
604 | 627 | <!-- AUTO-GENERATED-CONTENT:END --> |
605 | 628 |
|
606 | 629 | ### 7.2. Development |
|
631 | 654 | | [eslint-plugin-prettier@^2.2.0](https://github.com/prettier/eslint-plugin-prettier#readme) | Runs prettier as an eslint rule | 2.6.0 | MIT | dev | |
632 | 655 | | [[email protected]](https://github.com/xjamundx/eslint-plugin-promise#readme) | Enforce best practices for JavaScript promises | 3.7.0 | ISC | dev | |
633 | 656 | | [[email protected]](https://github.com/nodesecurity/eslint-plugin-security#readme) | Security rules for eslint | 1.4.0 | Apache-2.0 | dev | |
634 | | - | [eslint-plugin-standard@3.0.1](https://github.com/xjamundx/eslint-plugin-standard#readme) | ESlint Plugin for the Standard Linter | 3.0.1 | MIT | dev | |
| 657 | + | [eslint-plugin-standard@3.1.0](https://github.com/xjamundx/eslint-plugin-standard#readme) | ESlint Plugin for the Standard Linter | 3.0.1 | MIT | dev | |
635 | 658 | | [[email protected]](https://github.com/sindresorhus/eslint-plugin-unicorn#readme) | Various awesome ESLint rules | 4.0.3 | MIT | dev | |
636 | 659 | | [[email protected]](https://github.com/Rantanen/eslint-plugin-xss#readme) | Validates XSS related issues of mixing HTML and non-HTML content in variables. | 0.1.9 | ISC | dev | |
637 | 660 | | [[email protected]](https://github.com/henrikjoreteg/fixpack) | cli tool that cleans up package.json files. | 2.3.1 | MIT | dev | |
|
640 | 663 | | [[email protected]](https://github.com/jest-community/jest-runner-eslint) | An experimental ESLint runner for Jest | 0.4.0 | MIT | dev | |
641 | 664 | | [[email protected]](https://github.com/jsdoc3/jsdoc#readme) | An API documentation generator for JavaScript. | 3.5.5 | Apache-2.0 | dev | |
642 | 665 | | [lec@^1.0.1](https://github.com/iShafayet/lec) | Command Line Wrapper for Line Ending Corrector (An utility that makes sure your files have consistent line endings) | 1.0.1 | MIT | dev | |
643 | | - | [[email protected].4](https://github.com/okonet/lint-staged#readme) | Lint files staged by git | 7.0.4 | MIT | dev | |
| 666 | + | [[email protected].5](https://github.com/okonet/lint-staged#readme) | Lint files staged by git | 7.0.4 | MIT | dev | |
644 | 667 | | [[email protected]](https://lodash.com/) | The modern build of lodash’s `_.isUndefined ` as a module. | 3.0.1 | MIT | dev | |
645 | 668 | | [[email protected]](https://lodash.com/) | The lodash method `_.set ` exported as a module. | 4.3.2 | MIT | dev | |
646 | 669 | | [[email protected]](https://github.com/DavidWells/markdown-magic#readme) | Automatically update markdown files with content from external sources | 0.1.21 | MIT | dev | |
@@ -1015,10 +1038,10 @@ Make sure you use resources that you have the rights to use. If you use librarie |
1015 | 1038 | [icon-issue-image]: ./assets/img/icons8/icon-issues.png |
1016 | 1039 | [icon-pr-image]: ./assets/img/icons8/icon-pr.png |
1017 | 1040 | [icon-rest-api-image]: ./assets/img/icons8/icon-rest-api.png |
1018 | | -[issues-new-defect-image]: https://img.shields.io/badge/report-defect-F5CB5C.svg?style=for-the-badge&label=report+a |
| 1041 | +[issues-new-defect-image]: https://img.shields.io/badge/report-defect-e99695.svg?style=for-the-badge&label=report+a |
1019 | 1042 | [issues-new-defect-url]: /commonality/readme-inspector.git/issues/new?title=defect%28scope%29%3A+summary-of-change&labels=priority%3A+medium%2Cstatus%3A+review+needed%2Ctype%3A+defect&body=%2A%2A%F0%9F%92%A1+TIP%3A%2A%2A+Select+the+%E2%86%96%EF%B8%8E%E2%8E%BE+Preview+%E2%8F%8B+Tab+above+help+read+these+instructions.%0D%0A%0D%0A%23%23+1.+Issue+type%0D%0A%3E%E2%8C%A6+Type+the+letter+%22x%22+in+the+%22checkbox%22+the+best+describe+this+issue.%0D%0A%0D%0A-+%5Bx%5D+**Feature%3A**+I%27m+requesting+a+product+enhancement.%0D%0A%0D%0A%23%23+2.+User+story+summary%0D%0A%3E%E2%8C%A6+Describe+what+you+want+to+accomplish%2C+in+what+role%2Fcapacity%2C+and+why+it%27s+important+to+you.%0D%0A%0D%0A%3E+**EXAMPLE%3A**%0D%0A%3E+As+a+Applicant%2C%0D%0A%3E+I+want+to+submit+my+resume%0D%0A%3E+In+order+to+be+considered+for+a+job+opening.%0D%0A%0D%0AAs+a+%7Brole%7D%2C%0D%0AI+must%2Fneed%2Fwant%2Fshould+%7Bdo+something%7D%0D%0AIn+order+to+%7Bachieve+value%7D.%0D%0A%0D%0A%23%23+3.+Acceptance+criteria%0D%0A%3E%E2%8C%A6+Replace+the+examples+below+with+your+own+imperative%2C+%22true%2Ffalse%22+statements+for+the+**behavior+you+expect**+to+see%2C+or+the+behavior+that+**would**+be+true+if+there+were+no+errors+%28for+defects%29.%0D%0A%0D%0A-+%5B+%5D+1.+Job+Applicants+receive+a+confirmation+email+after+they+submit+their+resumes.%0D%0A-+%5B+%5D+2.+An+Applicant%27s+resume+information+isn%27t+lost+when+errors+occur.%0D%0A-+%5B+%5D+3.+%7Bcriterion-three%7D%0D%0A-+%5B+%5D+4.+%7Bcriterion-four%7D%0D%0A%0D%0A%3C%21--+%E2%9B%94%EF%B8%8F++Do+not+remove+anything+below+this+comment.+%E2%9B%94%EF%B8%8F++--%3E%0D%0A%5Bicon-info-image%5D%3A+..%2Fdocs%2Fimg%2Ficons8%2Ficon-info-50.png%0D%0A |
1020 | 1043 | [issues-new-defect-url]: https://github.com/commonality/readme-inspector/issues/new?title=defect%28scope%29%3A+summary-of-problem&labels=priority%3A+medium%2Cstatus%3A+review+needed%2Ctype%3A+defect&body=%2A%2A%F0%9F%92%A1+TIP%3A%2A%2A+Select+the+%E2%86%96%EF%B8%8E%E2%8E%BE+Preview+%E2%8F%8B+Tab+above+help+read+these+instructions.%0D%0A%0D%0A%23%23+1.+Issue+type%0D%0A%3E%E2%8C%A6+Type+the+letter+%22x%22+in+the+%22checkbox%22+the+best+describe+this+issue.%0D%0A%0D%0A-+%5Bx%5D+**Feature%3A**+I%27m+requesting+a+product+enhancement.%0D%0A%0D%0A%23%23+2.+User+story+summary%0D%0A%3E%E2%8C%A6+Describe+what+you+want+to+accomplish%2C+in+what+role%2Fcapacity%2C+and+why+it%27s+important+to+you.%0D%0A%0D%0A%3E+**EXAMPLE%3A**%0D%0A%3E+As+a+Applicant%2C%0D%0A%3E+I+want+to+submit+my+resume%0D%0A%3E+In+order+to+be+considered+for+a+job+opening.%0D%0A%0D%0AAs+a+%7Brole%7D%2C%0D%0AI+must%2Fneed%2Fwant%2Fshould+%7Bdo+something%7D%0D%0AIn+order+to+%7Bachieve+value%7D.%0D%0A%0D%0A%23%23+3.+Acceptance+criteria%0D%0A%3E%E2%8C%A6+Replace+the+examples+below+with+your+own+imperative%2C+%22true%2Ffalse%22+statements+for+the+**behavior+you+expect**+to+see%2C+or+the+behavior+that+**would**+be+true+if+there+were+no+errors+%28for+defects%29.%0D%0A%0D%0A-+%5B+%5D+1.+Job+Applicants+receive+a+confirmation+email+after+they+submit+their+resumes.%0D%0A-+%5B+%5D+2.+An+Applicant%27s+resume+information+isn%27t+lost+when+errors+occur.%0D%0A-+%5B+%5D+3.+%7Bcriterion-three%7D%0D%0A-+%5B+%5D+4.+%7Bcriterion-four%7D%0D%0A%0D%0A%3C%21--+%E2%9B%94%EF%B8%8F++Do+not+remove+anything+below+this+comment.+%E2%9B%94%EF%B8%8F++--%3E%0D%0A%5Bicon-info-image%5D%3A+..%2Fdocs%2Fimg%2Ficons8%2Ficon-info-50.png%0D%0A |
1021 | | -[issues-new-feat-image]: https://img.shields.io/badge/request-feature-c1ccc6.svg?style=for-the-badge&label=request+a |
| 1044 | +[issues-new-feat-image]: https://img.shields.io/badge/request-feature-0052cc.svg?style=for-the-badge&label=request+a |
1022 | 1045 | [issues-new-feat-url]: /commonality/readme-inspector.git/issues/new?title=feat%28scope%29%3A+summary-of-change&labels=priority%3A+medium%2Cstatus%3A+review+needed%2Ctype%3A+feature&body=%2A%2A%F0%9F%92%A1+TIP%3A%2A%2A+Select+the+%E2%86%96%EF%B8%8E%E2%8E%BE+Preview+%E2%8F%8B+Tab+above+help+read+these+instructions.%0D%0A%0D%0A%23%23+1.+Issue+type%0D%0A%3E%E2%8C%A6+Type+the+letter+%22x%22+in+the+%22checkbox%22+the+best+describe+this+issue.%0D%0A%0D%0A-+%5Bx%5D+**Feature%3A**+I%27m+requesting+a+product+enhancement.%0D%0A%0D%0A%23%23+2.+User+story+summary%0D%0A%3E%E2%8C%A6+Describe+what+you+want+to+accomplish%2C+in+what+role%2Fcapacity%2C+and+why+it%27s+important+to+you.%0D%0A%0D%0A%3E+**EXAMPLE%3A**%0D%0A%3E+As+a+Applicant%2C%0D%0A%3E+I+want+to+submit+my+resume%0D%0A%3E+In+order+to+be+considered+for+a+job+opening.%0D%0A%0D%0AAs+a+%7Brole%7D%2C%0D%0AI+must%2Fneed%2Fwant%2Fshould+%7Bdo+something%7D%0D%0AIn+order+to+%7Bachieve+value%7D.%0D%0A%0D%0A%23%23+3.+Acceptance+criteria%0D%0A%3E%E2%8C%A6+Replace+the+examples+below+with+your+own+imperative%2C+%22true%2Ffalse%22+statements+for+the+**behavior+you+expect**+to+see%2C+or+the+behavior+that+**would**+be+true+if+there+were+no+errors+%28for+defects%29.%0D%0A%0D%0A-+%5B+%5D+1.+Job+Applicants+receive+a+confirmation+email+after+they+submit+their+resumes.%0D%0A-+%5B+%5D+2.+An+Applicant%27s+resume+information+isn%27t+lost+when+errors+occur.%0D%0A-+%5B+%5D+3.+%7Bcriterion-three%7D%0D%0A-+%5B+%5D+4.+%7Bcriterion-four%7D%0D%0A%0D%0A%3C%21--+%E2%9B%94%EF%B8%8F++Do+not+remove+anything+below+this+comment.+%E2%9B%94%EF%B8%8F++--%3E%0D%0A%5Bicon-info-image%5D%3A+..%2Fdocs%2Fimg%2Ficons8%2Ficon-info-50.png%0D%0A |
1023 | 1046 | [issues-new-feat-url]: https://github.com/commonality/readme-inspector/issues/new?title=feat%28scope%29%3A+summary-of-change&labels=priority%3A+medium%2Cstatus%3A+review+needed%2Ctype%3A+feature&body=%2A%2A%F0%9F%92%A1+TIP%3A%2A%2A+Select+the+%E2%86%96%EF%B8%8E%E2%8E%BE+Preview+%E2%8F%8B+Tab+above+help+read+these+instructions.%0D%0A%0D%0A%23%23+1.+Issue+type%0D%0A%3E%E2%8C%A6+Type+the+letter+%22x%22+in+the+%22checkbox%22+the+best+describe+this+issue.%0D%0A%0D%0A-+%5Bx%5D+**Feature%3A**+I%27m+requesting+a+product+enhancement.%0D%0A%0D%0A%23%23+2.+User+story+summary%0D%0A%3E%E2%8C%A6+Describe+what+you+want+to+accomplish%2C+in+what+role%2Fcapacity%2C+and+why+it%27s+important+to+you.%0D%0A%0D%0A%3E+**EXAMPLE%3A**%0D%0A%3E+As+a+Applicant%2C%0D%0A%3E+I+want+to+submit+my+resume%0D%0A%3E+In+order+to+be+considered+for+a+job+opening.%0D%0A%0D%0AAs+a+%7Brole%7D%2C%0D%0AI+must%2Fneed%2Fwant%2Fshould+%7Bdo+something%7D%0D%0AIn+order+to+%7Bachieve+value%7D.%0D%0A%0D%0A%23%23+3.+Acceptance+criteria%0D%0A%3E%E2%8C%A6+Replace+the+examples+below+with+your+own+imperative%2C+%22true%2Ffalse%22+statements+for+the+**behavior+you+expect**+to+see%2C+or+the+behavior+that+**would**+be+true+if+there+were+no+errors+%28for+defects%29.%0D%0A%0D%0A-+%5B+%5D+1.+Job+Applicants+receive+a+confirmation+email+after+they+submit+their+resumes.%0D%0A-+%5B+%5D+2.+An+Applicant%27s+resume+information+isn%27t+lost+when+errors+occur.%0D%0A-+%5B+%5D+3.+%7Bcriterion-three%7D%0D%0A-+%5B+%5D+4.+%7Bcriterion-four%7D%0D%0A%0D%0A%3C%21--+%E2%9B%94%EF%B8%8F++Do+not+remove+anything+below+this+comment.+%E2%9B%94%EF%B8%8F++--%3E%0D%0A%5Bicon-info-image%5D%3A+..%2Fdocs%2Fimg%2Ficons8%2Ficon-info-50.png%0D%0A |
1024 | 1047 | [issues-url]: /commonality/readme-inspector/issues |
|
0 commit comments