Update contributing docs

ark120202 · ark120202 · commit e77fbf57165e · 2019-03-24T19:49:43.000+05:00
diff --git a/.editorconfig b/.editorconfig
@@ -8,5 +8,5 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.yml]
+[*.{yml,md}]
 indent_size = 2
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -29,17 +29,29 @@ The tests for this project can be executed using the standard `npm test`. This r
 
 Due to the time required to run all tests, it is impractical to run every test while developing part of the transpiler. To speed up the test run you can:
 
-- Use `npm test -- --watchAll` to start tests and rerun them on change
-- Use `npm test name` or interactive watching interface to run tests that match a file name pattern
-- Add `.only` to test definition to run a single test in the file
+- Use `npm test name` to run tests that match a file name pattern
+
+- Use `npm test -- --watchAll [name]` to start tests and rerun them on change
+
+- Check out `Watch Usage` in the watching interface to get information about filtering tests without restarting CLI
+
+- Use `.only` and `.skip` to filter executed tests in the file
+
+  ```ts
+  // Skipped
+  test("test", () => {});
+
+  // Executed
+  test.only("test", () => {});
+  ```
 
 ## Testing Guidelines
 When submitting a pull request with new functionality, we require some functional (transpile and execute Lua) to be added, to ensure the new functionality works as expected, and will continue to work that way.
 
 Translation tests are discouraged as in most cases as we do not really care about the exact Lua output, as long as executing it results in the correct result (which is tested by functional tests).
 
 ## Coding Conventions
-Most coding conventions are enforced by the TSLint and Prettier. You can check your code locally by running `npm run lint`. CI process will fail if code does not pass the linter. You also might want to get extensions for your code editor to get immediate feedback.
+Most coding conventions are enforced by the TSLint and Prettier. You can check your code locally by running `npm run lint`. The CI build will fail if your code does not pass the linter. For better experience, you can install extensions for your code editor for [TSLint](https://palantir.github.io/tslint/usage/third-party-tools/) and [Prettier](https://prettier.io/docs/en/editors.html).
 
 Some extra conventions worth mentioning:
 * Do not abbreviate variable names. The exception here are inline lambda arguments, if it is obvious what the argument is you can abbreviate to the first letter, e.g: `statements.filter(s => ts.VariableStatement(s))`
diff --git a/package.json b/package.json
@@ -42,6 +42,7 @@
         "overrides": [
             {
                 "files": [
+                    "**/*.md",
                     "**/*.yml",
                     "**/.*.yml"
                 ],

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@`
`42`	`42`	`"overrides": [`
`43`	`43`	`{`
`44`	`44`	`"files": [`
	`45`	`+ "*/.md",`
`45`	`46`	`"*/.yml",`
`46`	`47`	`"*/..yml"`
`47`	`48`	`],`