-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathcommit.txt
65 lines (46 loc) · 2.74 KB
/
commit.txt
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
# If applied, this commit will...(your subject line here)
# e.g fix: Fix typo in introduction to user guide
#<type>(<scope>): <subject>
#<body>
#<footer>
# Header: type is mandatory and scope is optional
# scope should be the area affected e.g. api, ui etc
# use the imperative, present tense: "change" not "changed" nor "changes", don't end with a period
# No more than 50 chars. #### 50 chars is here: #
# Remember blank line between header and body.
# type must be one of the following:-
# build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm, yarn)
# ci: Changes to configuration files and scripts
# docs: Documentation only changes
# feat: A new feature
# fix: A bug fix
# perf: A code change that improves performance
# refactor: A code change that neither fixes a bug nor adds a feature
# style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
# test: Adding missing tests or correcting existing tests
# chore: maintainance
# Body: Explain _what_ and _why_ (not _how_). Include task ID (Jira issue).
# Wrap at 72 chars. ################################## which is here:
# Footer: should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit closes.
# Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this
# At the end: Include Co-authored-by for all contributors.
# Include at least one empty line before it. Format:
# Co-authored-by: name <[email protected]>
# Sample:
## fix(release): need to depend on latest rxjs and zone.js
## The version in our package.json gets copied to the one we publish, and users need the latest of these.
# How to Write a Git Commit Message:
# https://chris.beams.io/posts/git-commit/
# https://www.conventionalcommits.org/en/v1.0.0/
# https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#commit
Issue Labels:
Label Description
- bug Indicates an unexpected problem or unintended behavior
- documentation Indicates a need for improvements or additions to documentation
- duplicate Indicates similar issues, pull requests, or discussions
- enhancement Indicates new feature requests
- good first issue Indicates a good issue for first-time contributors
- help wanted Indicates that a maintainer wants help on an issue or pull request
- invalid Indicates that an issue, pull request, or discussion is no longer relevant
- question Indicates that an issue, pull request, or discussion needs more information
- wontfix Indicates that work won't continue on an issue, pull request, or discussion