diff options
| author | Oliv4945 <oliv4945@gmail.com> | 2019-01-10 16:23:33 +0300 |
|---|---|---|
| committer | Oliv4945 <oliv4945@gmail.com> | 2019-01-10 16:23:33 +0300 |
| commit | c5860f2cd74a37269e66cb2ca15aa83e19d0f31a (patch) | |
| tree | ea04a22a26bccad3ac5cecc250500d8b7a9d2e32 /contributing.md | |
| parent | ac1e6e645499d659ad564cfd215b0d9d5239d90b (diff) | |
Start contributing documentation
Diffstat (limited to 'contributing.md')
| -rw-r--r-- | contributing.md | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/contributing.md b/contributing.md index 1e75baf..d2bf331 100644 --- a/contributing.md +++ b/contributing.md @@ -1,2 +1,18 @@ +# Contribute to code If you want to contribute make sure the commits are `verified`. -You can read how to GPG sign you commits [here](https://help.github.com/articles/signing-commits-using-gpg/).
\ No newline at end of file +You can read how to GPG sign you commits [here](https://help.github.com/articles/signing-commits-using-gpg/). + + +# Tools used +[Karma](https://karma-runner.github.io): JS test framework +[Bourbon](https://www.bourbon.io/): Sass->css framework +[Grunt](https://gruntjs.com/): Automation tool to compile/test/deploy + +# Test +With Docker: +``` +docker build . -t passman-dev && docker run -it --rm --user=`id -u` passman-dev grunt test +``` + +# Tips +Compile scss to scc: `grunt watch`
\ No newline at end of file |