chore: Update CONTRIBUTING

This commit is contained in:
equinusocio 2017-12-29 10:07:49 +01:00
parent 01a9dcdee5
commit 686eed07eb
No known key found for this signature in database
GPG key ID: 7BE552533AB6D4E2

View file

@ -7,6 +7,24 @@ Contributing guidelines
* Nodejs ^6.x
* Visual Studio Code
* GPG Tool
<!-- TOC -->
- [Requirements:](#requirements)
- [Decrypt content](#decrypt-content)
- [or](#or)
<!-- /TOC -->
### Decrypt content
We use git-crypt to encrypt compiler files. To contribute you need a GPG key public/private associated with your github email.
1. Export your public key by running
```gpg --output PATH/FILENAME.gpg --export ASSOCIATEDEMAIL```
2. Send the exported `.gpg` file to a contributor that will add you to the trusted people.
3. Fetch and pull then decrypt files with `git-crypt unlock` entering your key password.
### Installing and compiling source