Add info about contributing to README

Author: sheaf

Makefile

@@ -6,15 +6,19 @@ SCOPE_LISTS=$(addsuffix .md,$(addprefix scope-lists/,$(SYNTAXES)))
 
 .PHONY: all test publish package
 
-all: $(JSON_TARGETS) $(SCOPE_LISTS)
+all: grammars scopes
+
+grammars: $(JSON_TARGETS)
+
+scopes: $(SCOPE_LISTS)
 
 scope-lists/%.md: scope-lists/%.yaml
 	scope-lists/refresh.hs md $< $@
 
 scope-lists/%.yaml: syntaxes/%.YAML-tmLanguage
 	scope-lists/refresh.hs db $< $@
 
-test: all
+test: grammars
 	cd test && bash test.sh
 
 %.json: %.YAML-tmLanguage

PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
 ## For changes related to the grammar
 
 - Please add a test case.
-  
+
   - For changes to regular Haskell code simply add a new section to `test/syntax-examples/test.hs`.
     Make sure your case has a descriptive comment about what it is covering.
 

README.md

@@ -45,3 +45,24 @@ extension or if there are further scope assigments you'd like to see added.
 We now publish an automatically generated, complete list of the textmate scopes
 used in our grammars. You can find the lists of scopes in the
 [scope-lists](/scope-lists) directory.
+
+## Contributing
+
+This project currently uses the `YAML-tmLanguage` format for language grammars (Haskell, Cabal, alex, happy, ...).
+The grammars can be found in the `syntaxes` directory.  
+To generate `JSON` grammars (which is the format VS Code expects), we use the Node package `js-yaml` (requires `npx` in PATH):
+
+```sh
+npx js-yaml haskell.YAML-tmLanguage > haskell.json
+```
+
+For testing, we use the Node package `vscode-tmgrammar-test`. For instance, to generate/check
+the scopes of a Haskell source file, run:
+
+```sh
+npx vscode-tmgrammar-test "-s" "source.haskell" "-g" "syntaxes/haskell.json" "-t" "myTestFile.hs"
+```
+
+
+To run the test-suite, simply call `make test`.
+This will build the grammar files and run `vscode-tmgrammar-test` on all the files in the testsuite.

test/test.sh

@@ -59,15 +59,15 @@ runTests () {
         expectBroken=1
       fi
     done
-  
+
     # Set the appropriate syntax file for the test.
     case $ext in
-  
+
       "hs" | "hs-boot" | "hsig" )
         syntaxes=( "$baseDir/syntaxes/haskell.json" )
         source="source.haskell"
         ;;
-  
+
       "cabal" )
         syntaxes=( "$baseDir/syntaxes/cabal.json" )
         source="source.cabal"
@@ -94,7 +94,7 @@ runTests () {
         ;;
 
     esac
-  
+
     if [ ${#syntaxes[@]} -eq 0 ]
     then
       echo "runTests: $file has unsupported file extension '$ext', ignoring"