Skip to content

Commit 411fbf9

Browse files
committed
Chore: add semantic-git-commit-cli
1 parent 24e59f9 commit 411fbf9

File tree

5 files changed

+1687
-160
lines changed

5 files changed

+1687
-160
lines changed

.sgcrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
{
2+
}

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,14 @@ We're always looking for more opinions on discussions in the issue tracker. It's
2626
- For ambitious tasks, you should try to get your work in front of the community for feedback as soon as possible. Open a pull request as soon as you have done the minimum needed to demonstrate your idea. At this early stage, don't worry about making things perfect, or 100% complete. Add a `[WIP]` prefix to the title, and describe what you still need to do. This lets reviewers know not to nit-pick small details or point out improvements you already know you need to make.
2727
- Don't include unrelated changes
2828
- New features should be accompanied with tests and documentation
29-
- Use a clear and descriptive title for the pull request and commits
29+
- Commit messages
30+
- Use a clear and descriptive title for the pull request and commits
31+
- We use [semantic-release](https://www.npmjs.com/package/semantic-release) to automatically generate release
32+
notes, versions and publish releases. This requires commit messages must be formatted properly using
33+
[Angular's git commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).
34+
- As a convenience, a tool called `semantic-git-commit-cli` is installed in node_modules so you can commit using
35+
`npx sgc` instead of `git commit`. This tool will ask a series of questions and generate a properly-formatted
36+
commit message for you. You can still run `git commit` and format the message properly yourself if you prefer.
3037
- Lint and test before submitting the pull request by running `$ npm test`
3138
- Write a convincing description of why we should land your pull request. Answer _why_ it's needed and provide use-cases.
3239
- Make the pull request from a [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) (not master)
@@ -56,4 +63,4 @@ can read and share information.
5663

5764
Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
5865

59-
Copyright 2019 SmartThings, Inc.
66+
Copyright 2019 SmartThings, Inc.

config/release.config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
analyzeCommits: {
3+
preset: 'eslint'
4+
},
5+
generateNotes: {
6+
preset: 'eslint'
7+
}
8+
}

0 commit comments

Comments
 (0)