embarklabs
/
embark
mirror of https://github.com/embarklabs/embark.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs(contributing): Update the syntax of the header and scope 

Add more detailed syntax and examples surround the commit header and scopes.
This commit is contained in:
emizzle 2019-03-20 11:57:52 +11:00 committed by Iuri Matias
parent 431d366652
commit 774ae4af9a
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -141,7 +141,7 @@ Each commit message consists of a **header**, a **body** and a **footer**. The
format that includes a **type**, a **scope** and a **subject**:
```
<type>(<scope>): <subject>
type(@embark|@cockpit/<SCOPE>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
@ -189,7 +189,9 @@ The following is the list of supported scopes:
* **@embark/cli** - Embark command line interface
* **@embark/core** - Embark core
* **@embark/<module>** - Embark core module
* **@embark/<`module`>** - Embark core module (any folder name under `packages/embark/src/lib/modules`), ie `@embark/console` or `@embark/debugger`
* **@embark/<`package`>** - Embark npm package in the monorepo (any folder name under `packages/`), ie `@embark/embarkjs` or `@embark/embark-compiler`
* **@cockpit/<`section`>** - Cockpit site section, ie `@cockpit/explorer`
There are currently a few exceptions to the "use package name" rule: