Browse Source

Start contributing documentation

pull/290/head
Oliv4945 7 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 @@
# 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/).
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`

Loading…
Cancel
Save