UNPKG

@in-ch/setup

Version:

A tool for quick setup and configuration of essential project files.

in-ch.github.io/setup

in-ch/setup

70 lines (63 loc) • 2.59 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# Commit Message Template # ▼ Write <header> # ▼ <blank line> # ▼ Write <body> # ▼ <blank line> # ▼ Write <footer> # Explanation of Format # - General Commit # <header> # - Required # - Format: <type>(<scope>): <short summary> # <type> # - Required # - build: Changes affecting the build system or external dependencies (e.g., gulp, broccoli, npm) # - ci: Changes to CI configuration files or scripts (e.g., CircleCi, SauceLabs) # - config: Add or update configuration files # - docs: Documentation updates # - feat: Adding new features # - fix: Bug fixes # - perf: Changes that improve performance # - refactor: Changes that are neither adding a feature nor fixing a bug # - remove: Code or file removals # - style: Changes related to styling or formatting # - test: Adding or updating tests # <scope> # - Optional # - Name of the npm package or the part of the code affected by the change # - Examples: location, browser, compile, rootScope... # <short summary> # - Required # - Concisely describe the change # - Use lowercase for the first letter, present tense, imperative mood, and do not end with a period. # # <body> # - At least 20 characters required (except for <type>docs) # - Write in present tense, imperative mood # - Explain the motivation (why) behind the changes # - May include a comparison of the previous behavior and the new behavior to clarify the impact # # <footer> # - Include Breaking Changes, deprecations, or references to related GitHub issues, Jira tickets, or pull requests # - Examples: # - 1. Breaking Changes # BREAKING CHANGE: <summary of breaking change> # <blank line> # <Explanation of the breaking change + migration instructions> # <blank line> # <blank line> # Fixes #<issue number> # - 2. Deprecations # DEPRECATED: <deprecated item> # <blank line> # <Explanation of deprecation + recommended update path> # <blank line> # <blank line> # Closes #<PR number> # # - Revert Commit # <header> # revert: <header of the commit being reverted> # <body> # - This reverts commit <SHA of the reverted commit> # - Provide a clear explanation for the revert