Update CONTRIBUTING.md

CONTRIBUTING.md

@@ -1,94 +1,58 @@
-# Contribution guidelines
+# Contribution Guidelines
 
-**30 seconds of code** is a community effort, so feel free to contribute in any way you can. Every contribution helps!
+**30 seconds of code** is powered by the community, so feel free to contribute in any way you can to help us!
 
-Here's what you can do to help:
+## Tools
 
-- Submit [pull requests](https://github.com/30-seconds/30-seconds-of-code/pulls) with snippets and tests that you have created (see below for guidelines).
-- [Open issues](https://github.com/30-seconds/30-seconds-of-code/issues/new) for things you want to see added or modified.
-- Be part of the discussion by helping out with [existing issues](https://github.com/30-seconds/30-seconds-of-code/issues) or talking on our [gitter channel](https://gitter.im/30-seconds-of-code/Lobby).
-- Tag uncategorized snippets, update snippet tags to better categorize snippets.
-- Fix typos in existing snippets, improve snippet descriptions and explanations or provide better examples.
-- Write tests for existing snippets (see below for guidelines).
+Before you begin contributing, you should install the integration-tools globally on your machine:
 
-### Snippet submission and Pull request guidelines
+```sh
+npm install -g @30-seconds/integration-tools
+```
 
-- **DO NOT MODIFY ANY OF THE README.md FILES!** Make changes to individual snippet files. **Travis CI** will automatically build the `README.md` files when your pull request is merged.
-- **Snippet filenames** must correspond to the title of the snippet. For example, if your snippet is titled `awesomeSnippet` the filename should be `awesomeSnippet.md`.
-  - Use `camelCase`, not `kebab-case` or `snake_case`.
-  - Avoid capitalization of words, except if the whole word is capitalized (e.g. `URL` should be capitalized in the filename and the snippet title).
-- **Snippet metadata** must be included in all snippets in the form of frontmatter.
-  - All snippets must contain a title.
-  - All snippets must contain tags, prefixed with `tags:` and separated by commas (optional spaces in-between).
-  - Make sure the first tag in your snippet's tags is one of the main categories, as seen in the `README.md` file or the website.
-  - Snippet tags must include a difficulty setting (`beginner`, `intermediate` or `advanced`), preferrably at the end of the list.
-- **Snippet titles** should be the same as the name of the function that is present in the snippet.
-  - All snippet titles must be prefixed with `title:` and be at the very first line of your snippet's frontmatter.
-  - Snippet titles must be unique (although if you cannot find a better title, just add some placeholder at the end of the filename and title and we will figure it out).
-  - Follow snippet titles with an empty line.
-- **Snippet descriptions** must be short and to the point. Try to explain *what* the snippet does and *how* the snippet works and what Javascript features are used. Remember to include what functions you are using and why.
-  - Follow snippet descriptions with an empty line.
-- **Snippet code** must be enclosed inside ` ```js ` and ` ``` `.
-  - Remember to start your snippet's code on a new line below the opening backticks.
-  - Use ES6 notation to define your function. For example `const myFunction = ( arg1, arg2 ) => { }`.
-  - Please use Javascript [Semi-Standard Style](https://github.com/Flet/semistandard).
-  - Try to keep your snippets' code short and to the point. Use modern techniques and features. Make sure to test your code before submitting.
-  - All snippets must be followed by one (more if necessary) test case after the code, in a new block enclosed inside ` ```js ` and ` ``` `. The syntax for this is `myFunction('testInput'); // 'testOutput'`. Use multiline examples only if necessary.
-  - Try to make your function name unique, so that it does not conflict with existing snippets.
-  - Snippet functions do not have to handle errors in input, unless it's necessary (e.g. a mathematical function that cannot be extended to negative numbers should handle negative input appropriately).
-- Snippets should be short (usually below 10 lines). If your snippet is longer than that, you can still submit it, and we can help you shorten it or figure out ways to improve it.
-- Snippets *should* solve real-world problems, no matter how simple.
-- Snippets *should* be abstract enough to be applied to different scenarios.
-- It is not mandatory but highly appreciated if you provide **test cases** and/or performance tests (we recommend using [jsPerf](https://jsperf.com/)).
-- You can start creating a new snippet, by using the [snippet template](snippet-template.md) to format your snippets.
+This will allow you to use our customized tools for all of our content repositories.
 
-### Writing tests
-- Before writing any tests run `npm run packager` script. It will update test directory to include new snippets as well as update old ones if needed.
-- **DO NOT MODIFY THE _30s.js file** under test directory.
-- We are using [Jest](https://jestjs.io/) for testing.
-- Write tests under `snippetName.test.js` file. If you have trouble doing so, check out tests of other snippets.
-- Be sure to run `npm run test`. It is going to run all tests for all snippets.
-- Make a new pull request **only if all the tests are passing**.
-- If your snippet belongs in the `browser` category, some tests might not work exactly as expected. Check [Jest's Docs](https://jestjs.io/docs/en/getting-started) for additional information.
+## How you can help
 
-### Additional guidelines and conventions regarding snippets
+- Submit pull requests with new snippets (see guidelines below) or snippet updates (tags, descriptions, explanations, typos, examples, code improvements).
+- Open issues for things you want to see added, modified, discuss ideas or help out with existing issues. 
 
-- When describing snippets, refer to methods, using their full name. For example, use `Array.prototype.reduce()`, instead of `reduce()`.
-- If your snippet contains arguments with default parameters, explain what happens if they are omitted when calling the function and what the default case is.
-- If your snippet uses recursion, explain the base cases.
-- Always use `const functionName` for function definitions.
-- Use variables only when necessary. Prefer `const` when the values are not altered after assignment, otherwise, use `let`. Avoid using `var`.
-- Use `camelCase` for function and variable names, if they consist of more than one word.
-- Try to give meaningful names to variables. For example use `letter`, instead of `lt`. Some exceptions to convention are:
-  - `arr` for arrays (usually as the snippet function's argument).
-  - `str` for strings.
-  - `num` or `n` for a numeric value (usually as the snippet function's argument).
-  - `el` for DOM elements (usually as the snippet function's argument).
-  - `val` or `v` for value (usually when iterating a list, mapping, sorting etc.).
-  - `acc` for accumulators in `Array.prototype.reduce()`.
-  - `(a,b)` for the two values compared when using `Array.prototype.sort()`.
-  - `i` for indexes.
-  - `fn` for function arguments.
-  - `nums` for arrays of numbers.
-- Use `()` if your function takes no arguments.
-- Use `_` if an argument inside some function (e.g. `Array.prototype.reduce()`) is not used anywhere in your code.
-- Specify default parameters for arguments, if necessary. It is preferred to put default parameters last unless you have a pretty good reason not to.
-- If your snippet's function takes variadic arguments, use `...args` (although in certain cases, it might be needed to use a different name).
-- If your snippet function's body is a single statement, omit the `return` keyword and use an expression instead.
-- Always use soft tabs (2 spaces), never hard tabs.
-- Omit curly braces (`{` and `}`) whenever possible.
-- Always use single quotes for string literals. Use template literals, instead, if necessary.
-- If your snippet's code is short enough (around 80 characters), you can make it a single-line function (although not mandatory). Otherwise, use multiple lines.
-- Prefer using `Array` methods whenever possible.
-- Prefer `Array.prototype.concat()` instead of `Array.prototype.push()` when working with `Array.prototype.reduce()`.
-- Use strict equality checking (`===` and `!==` instead of `==` and `!=`), unless you specifically have reason not to.
-- Prefer using the ternary operator (`condition ? trueResult : falseResult`) instead of `if else` statements whenever possible.
-- Avoid nesting ternary operators (but you can do it if you feel like you should).
-- You should define multiple variables on the same line (e.g. `const x = 0, y = 0`) whenever possible.
-- Do not use trailing or leading underscores in variable names.
-- Use dot notation (`object.property`) for object properties, when possible. Use bracket notation (`object[variable]`) when accessing object properties using a variable.
-- Use arrow functions as much as possible, except when you can't.
-- Use semicolons whenever necessary. If your snippet function's body is a single statement, return an expression and add a semicolon at the end.
-- Leave a single space after a comma (`,`) character.
+## Ground rules
+
+Breaking any of these rules will result in your pull request being closed. Please follow these guidelines above all else:
+
+- **Always be polite and respectful to others** and try to follow the advice of the moderators/collaborators/owners.
+- **Only modify snippet files**, never modify the generated files in the `snippet_data` directory.
+- **Use the integration tools commands** to generate new snippets, ensuring they have the correct name and are in the correct location.
+- **Follow snippet format exactly**, otherwise your snippets will not be recognized correctly by the tools responsible for publishing them on the website. This includes such things as spacing and empty lines - if you accidentally make a mistake, consult the repository's [snippet template](snippet-template.md).
+- **Snippets should solve real-world problems**, no matter how simple and should be abstract enough to be applied to different scenarios.
+
+## Snippet creation
+
+After installing the integration tools, you can run the following command:
+
+```sh
+create-new-snippet <my-snippet-name>
+```
+
+Replace `<my-snippet-name>` with the name of the snippet you are adding. 
+
+## Snippet guidelines
+
+- Snippets must have all their frontmatter sections (title, tags etc.) filled.
+- Snippet titles must correspond to the filename and follow the language and repository's naming conventions.
+- Snippet tags must be comma-separated, contain a primary tag as seen on the website as their first tag and an expertise tag (`beginner`, `intermediate` or `advanced`) as their last tag.
+- Snippet descriptions must be short and to the point. Explain *what* the snippet does and detail *how* the snippet works and the language features used in it.
+- Snippet code and examples must be enclosed in appropriate, language-tagged blocks as shown in the snippet template, be short and use modern techniques and features. Also make sure to test your code before submitting.
+- If your snippet contains arguments with default parameters, explain what happens if they are omitted when calling the function and what the default case is. Specify default parameters for arguments only if necessary.
+- If your snippet uses recursion, use the `recursion` tag and explain the base cases.
 - Try to strike a balance between readability, brevity, and performance.
+- Always use soft tabs (2 spaces), never hard tabs.
+- Leave a single space after a comma (`,`) character (both in the description and code).
+- Define multiple variables on the same line, if possible. Use meaningful names (e.g. `letter` instead of `lt`) and follow existing conventions as seen in other snippets. Do not use trailing or leading underscores in variable names.
+- Use ES6 notation to define your snippet's function. For example `const myFunction = ( arg1, arg2 ) => { }`. Format your code based on [Semi-Standard Style](https://github.com/Flet/semistandard)'s format guidelines.
+- Always use single quotes for string literals. Use template literals, instead, if necessary.
+- Use strict equality checking (`===` and `!==` instead of `==` and `!=`).
+- When describing snippets, refer to methods, using their full name. For example, use `Array.prototype.reduce()`, instead of `reduce()`.
+- Use variables only when necessary. Prefer `const` when the values are not altered after assignment, otherwise, use `let`. Do not use `var`. 
 - Never use `eval()`. Your snippet will be disqualified immediately.