forks/vsc-material-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Mattia Astorino 2018-02-21 12:02:09 +01:00 committed by GitHub
parent 510efefe8d
commit a27ae3f412
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
CONTRIBUTING.md
View file

@ -1,18 +1,17 @@
Contributing guidelines # Contributing guidelines
=======================
> Note: this document is intended as a draft, it will be updated soon > Note: this document is intended as a draft, it will be updated soon
### Requirements: ## Requirements:
* Nodejs ^6.x * Nodejs ^6.x
* Visual Studio Code * Visual Studio Code
* GPG Tool * GPG Tool
- [Contributing guidelines](#contributing-guidelines) - [Contributing guidelines](#contributing-guidelines)
- [Requirements:](#requirements) - [Requirements:](#requirements)
- [Decrypt content](#decrypt-content) - [Decrypt content](#decrypt-content)
- [Installing and compiling source](#installing-and-compiling-source) - [Installing and compiling source](#installing-and-compiling-source)
- [Testing the theme](#testing-the-theme) - [Testing the theme](#testing-the-theme)
- [Adding new Material Theme commands](#adding-new-material-theme-commands) - [Adding new Material Theme commands](#adding-new-material-theme-commands)
- [Adding new icons](#adding-new-icons) - [Adding new icons](#adding-new-icons)
@ -22,18 +21,17 @@ Contributing guidelines
- [Backers](#backers) - [Backers](#backers)
- [Sponsors](#sponsors) - [Sponsors](#sponsors)
### Decrypt content ## Decrypt content
We use git-crypt to encrypt compiler files. To contribute you need a GPG key public/private associated with your github email. We use git-crypt to encrypt compiler files. To contribute you need a GPG key public/private associated with your github email.
1. Exp 1. Export your public key by running
t your public key by running
```gpg --output PATH/FILENAME.gpg --export ASSOCIATEDEMAIL``` ```gpg --output PATH/FILENAME.gpg --export ASSOCIATEDEMAIL```
2. Send the exported `.gpg` file to a contributor that will add you to the trusted people. 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. 3. Fetch and pull then decrypt files with `git-crypt unlock` entering your key password.
### Installing and compiling source ## Installing and compiling source
First you will have to install node_modules through npm or yarn First you will have to install node_modules through npm or yarn