-
-
Notifications
You must be signed in to change notification settings - Fork 198
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cd46b79
commit 78473c8
Showing
10 changed files
with
184 additions
and
67 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,40 @@ | ||
| version: 2 | ||
| jobs: | ||
| build_10.15.3: | ||
| docker: | ||
| - image: 'circleci/node:10.15.3' | ||
| working_directory: ~/app | ||
| steps: | ||
| - checkout | ||
| - restore_cache: | ||
| keys: | ||
| - 'v1-dependencies-{{ checksum "package.json" }}' | ||
| - v1-dependencies- | ||
| - run: npm install | ||
| - save_cache: | ||
| paths: | ||
| - node_modules | ||
| key: 'v1-dependencies-{{ checksum "package.json" }}' | ||
| - run: npm test | ||
| build_latest: | ||
| docker: | ||
| - image: 'circleci/node:latest' | ||
| working_directory: ~/app | ||
| steps: | ||
| - checkout | ||
| - restore_cache: | ||
| keys: | ||
| - 'v1-dependencies-{{ checksum "package.json" }}' | ||
| - v1-dependencies- | ||
| - run: npm install | ||
| - save_cache: | ||
| paths: | ||
| - node_modules | ||
| key: 'v1-dependencies-{{ checksum "package.json" }}' | ||
| - run: npm test | ||
| workflows: | ||
| version: 2 | ||
| workflow: | ||
| jobs: | ||
| - build_10.15.3 | ||
| - build_latest |
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,70 @@ | ||
| ## Git Commit Message Convention | ||
|
|
||
| > This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular). | ||
| Using conventional commit messages, we can automate the process of generating the CHANGELOG file. All commits messages will automatically be validated against the following regex. | ||
|
|
||
| ``` js | ||
| /^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types|build)((.+))?: .{1,50}/ | ||
| ``` | ||
|
|
||
| ## Commit Message Format | ||
| A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**: | ||
|
|
||
| > The **scope** is optional | ||
| ``` | ||
| feat(router): add support for prefix | ||
| Prefix makes it easier to append a path to a group of routes | ||
| ``` | ||
|
|
||
| 1. `feat` is type. | ||
| 2. `router` is scope and is optional | ||
| 3. `add support for prefix` is the subject | ||
| 4. The **body** is followed by a blank line. | ||
| 5. The optional **footer** can be added after the body, followed by a blank line. | ||
|
|
||
| ## Types | ||
| Only one type can be used at a time and only following types are allowed. | ||
|
|
||
| - feat | ||
| - fix | ||
| - docs | ||
| - style | ||
| - refactor | ||
| - perf | ||
| - test | ||
| - workflow | ||
| - ci | ||
| - chore | ||
| - types | ||
| - build | ||
|
|
||
| If a type is `feat`, `fix` or `perf`, then the commit will appear in the CHANGELOG.md file. However if there is any BREAKING CHANGE, the commit will always appear in the changelog. | ||
|
|
||
| ### Revert | ||
| If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>`., where the hash is the SHA of the commit being reverted. | ||
|
|
||
| ## Scope | ||
| The scope could be anything specifying place of the commit change. For example: `router`, `view`, `querybuilder`, `database`, `model` and so on. | ||
|
|
||
| ## Subject | ||
| The subject contains succinct description of the change: | ||
|
|
||
| - use the imperative, present tense: "change" not "changed" nor "changes". | ||
| - don't capitalize first letter | ||
| - no dot (.) at the end | ||
|
|
||
| ## Body | ||
|
|
||
| Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". | ||
| The body should include the motivation for the change and contrast this with previous behavior. | ||
|
|
||
| ## Footer | ||
|
|
||
| The 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. | ||
|
|
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
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
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
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 |
|---|---|---|
| @@ -1,12 +1,11 @@ | ||
| { | ||
| "core": true, | ||
| "ts": false, | ||
| "ts": true, | ||
| "license": "MIT", | ||
| "services": [ | ||
| "travis", | ||
| "appveyor", | ||
| "coveralls" | ||
| "circleci" | ||
| ], | ||
| "appveyorUsername": "thetutlage", | ||
| "minNodeVersion": "8.0.0" | ||
| "minNodeVersion": "10.15.3" | ||
| } |
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 |
|---|---|---|
| @@ -1,4 +1,6 @@ | ||
| require('ts-node/register') | ||
|
|
||
| const { configure } = require('japa') | ||
| configure({ | ||
| files: ['test/**/*.spec.js'] | ||
| files: ['test/**/*.spec.ts'] | ||
| }) |
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
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,3 @@ | ||
| { | ||
| "extends": "./node_modules/@adonisjs/mrm-preset/_tsconfig" | ||
| } |
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,8 @@ | ||
| { | ||
| "extends": [ | ||
| "@adonisjs/mrm-preset/_tslint" | ||
| ], | ||
| "rules": { | ||
| "await-promise": true | ||
| } | ||
| } |