nicolas/librenms
1
0
Fork 0
mirror of https://github.com/stylersnico/librenms.git synced 2026-08-03 08:01:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: Merge remote-tracking branch 'spalger/master' - make npm ready

Browse Source
This commit is contained in:
David Morse
2015-06-04 19:41:11 -06:00
parent c5da395c53 99e8736b0c
commit 393b4fc9ec
3 changed files with 66 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.npmignore
+4
View File
@@ -0,0 +1,4 @@
*
!README.md
!LICENSE
!dist/**/*
CONTRIBUTING.md
+57
View File
@@ -141,3 +141,60 @@ included in the project:
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to **IMPORTANT**: By submitting a patch, you agree to allow the project owner to
license your work under the same license as that used by the project. license your work under the same license as that used by the project.
#commit Message Guidelines
We use [automatic changelog creation](https://github.com/ajoslin/conventional-changelog), so it best if your commit messages follow the following conventions:
### Commit Message Format
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
format that includes a **type**, a **scope** and a **subject**:
```
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
to read on github as well as in various git tools.
### Type
Must be one of the following:
* **feat**: A new feature
* **fix**: A bug fix
* **docs**: Documentation only changes
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
semi-colons, etc)
* **refactor**: A code change that neither fixes a bug or adds a feature
* **perf**: A code change that improves performance
* **test**: Adding missing tests
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
generation
### Scope
The scope could be anything specifying place of the commit change. For example `$location`,
`$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...
### 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** are detected as such if the Body contains a line starting with
`BREAKING CHANGES:` The rest of the commit message is then used for this.
A detailed explanation can be found in this [document](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/).
package.json
+5
View File
@@ -14,6 +14,7 @@
"bugs": { "bugs": {
"url": "https://github.com/dsmorse/gridster.js/issues" "url": "https://github.com/dsmorse/gridster.js/issues"
}, },
"license": "MIT",
"licenses": [ "licenses": [
{ {
"type": "MIT", "type": "MIT",
@@ -42,5 +43,9 @@
}, },
"scripts": { "scripts": {
"test": "grunt test" "test": "grunt test"
},
"main": "dist/jquery.gridster.js",
"directories": {
"test": "test"
} }
} }