Skip to content

Commit 866cd78

Browse files
docs: add basic documentation
1 parent 7d447f5 commit 866cd78

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
11
# sass-lint-config-airhelp
2-
AirHelp SASSLint shareable config
2+
npm package with AirHelp SASSLint shareable config
3+
##Usage
4+
1. Install `sass-lint`
5+
```
6+
npm install --save-dev sass-lint
7+
```
8+
2. Create `.sass-lint.yml` in root directory same as `package.json`
9+
3. Add path AirHelp SASSLint shareable config to to the `.sass-lint.yml` file
10+
```yml
11+
options:
12+
config-file: node_modules/sass-lint-config-airhelp/.sass-lint.yml
13+
```
14+
##Contribution
15+
Please introduce changes in separate PRs.
16+
17+
This package is using [simple-git-changelog](https://github.com/ianhenderson/simple-git-changelog) for creating changelog. Please use following prefixes for all commits that are supposed to be part of changelog:
18+
* `changelog`
19+
* `fix`
20+
* `docs`
21+
* `chore`
22+
* `feat`
23+
* `feature`
24+
* `refactor`
25+
* `update`
26+
27+
for example:
28+
```
29+
git commit -m "fix: lorem ispum dolor"
30+
```

0 commit comments

Comments
 (0)