This repository has been archived by the owner on Aug 30, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(github): adding support for Pull Requests templates
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
## Commit Message Guidelines | ||
``` | ||
Header | ||
Blank Line | ||
Body | ||
Blank Line | ||
Footer | ||
The header should look like: | ||
<type>(<scope>): <subject> | ||
The body should have any necessary detailed info about the commit: | ||
An example, references as to where this idea came from, etc. | ||
The footer should have all the issues tagged: | ||
Fixes #123, Fixes #456 | ||
So a commit should like like: | ||
feat(users): Add new Yahoo authentication | ||
Yahoo authentication idea proposed by @codydaig | ||
Example implementation in file.js | ||
Fixes #82 | ||
``` | ||
|
||
* Types: | ||
* feat - Features, Enhancements, and overall Improvements | ||
* fix - Fixes, Bugs, HotFixs, etc... | ||
* doc - Changes to the Documentation and doesn't actually touch any code. | ||
* Scope: | ||
* The scope should be where the change took place. | ||
* Examples: users, core, config, articles | ||
* Subject: | ||
* The subject line should be clear and concise as to what is being accomplished in the commit. | ||
* General Rules: | ||
* No Line in the Commit message can be longer than 80 characters. | ||
* Refrence: [Angular Conventions](https://github.com/ajoslin/conventional-changelog/blob/master/conventions/angular.md) |