Browse Source

Start contributing documentation

Oliv4945 4 months ago
parent
commit
c5860f2cd7
No account linked to committer's email address
1 changed files with 17 additions and 1 deletions
  1. 17
    1
      contributing.md

+ 17
- 1
contributing.md View File

@@ -1,2 +1,18 @@
1
+# Contribute to code
1 2
 If you want to contribute make sure the commits are `verified`.   
2
-You can read how to GPG sign you commits [here](https://help.github.com/articles/signing-commits-using-gpg/).
3
+You can read how to GPG sign you commits [here](https://help.github.com/articles/signing-commits-using-gpg/).
4
+
5
+
6
+# Tools used
7
+[Karma](https://karma-runner.github.io): JS test framework
8
+[Bourbon](https://www.bourbon.io/): Sass->css framework
9
+[Grunt](https://gruntjs.com/): Automation tool to compile/test/deploy
10
+
11
+# Test
12
+With Docker:
13
+```
14
+docker build . -t passman-dev && docker run -it --rm --user=`id -u` passman-dev grunt test
15
+```
16
+
17
+# Tips
18
+Compile scss to scc: `grunt watch`