From bb1ccba27d4e35b4d7e4ca57b78829d62512726b Mon Sep 17 00:00:00 2001 From: Angelos Chalaris Date: Sat, 8 Sep 2018 14:53:08 +0300 Subject: [PATCH] Contributing page --- docs/contributing.html | 79 ++++++++++++++++++++++++++++++++++ scripts/web.js | 8 ++++ static-parts/contributing.html | 79 ++++++++++++++++++++++++++++++++++ 3 files changed, 166 insertions(+) create mode 100644 docs/contributing.html create mode 100644 static-parts/contributing.html diff --git a/docs/contributing.html b/docs/contributing.html new file mode 100644 index 000000000..0bacda03e --- /dev/null +++ b/docs/contributing.html @@ -0,0 +1,79 @@ + + + + + + + + Contributing - 30 seconds of code + + + + + + + + + + + + + +
+

logo 30 + seconds of code + Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less. +

+
+
+
+

+

How to contribute

+

Do you have a cool idea for a new snippet? Maybe some code you use often and is not part of our collection? Contributing to 30 seconds of code is as simple as 1,2,3,4!


+

1. Create

+

Start by creating a snippet, according to the snippet template. Make sure to follow these simple guidelines:

+
    +
  • Your snippet title must be unique and the same as the name of the implemented function.
    • +
  • Use the snippet description to explain what your snippet does and how it works.
    • +
  • Try to keep the snippet's code short and to the point. Use modern techniques and features.
    • +
  • Remember to provide an example of how your snippet works.
    • +
  • Your snippet should solve a real-world problem, no matter how simple.
    • +
  • Never modify README.md or any of the HTML files.
    • +

+

2. Tag

+

Run npm run tagger from your terminal, then open the tag_database file and tag your snippet appropriately. Multitagging is also supported, just make sure the first tag you specify is on of the major tags and the one that is most relevant to the implemented function.


+

3. Test

+

You can optionally test your snippet to make our job easier. Simply run npm run tester to generate the test files for your snippet. Find the related folder for you snippet under the test directory and write some tests. Remember to run npm run tester again to make sure your tests are passing.


+

4. Pull request

+

If you have done everything mentioned above, you should now have an awesome snippet to add to our collection. Simply start a pull request and follow the guidelines provided. Remember to only submit one snippet per pull request, so that we can quickly evaluate and merge your code into the collection.


+
+ +
+ + + + diff --git a/scripts/web.js b/scripts/web.js index c2be14010..ca1267695 100644 --- a/scripts/web.js +++ b/scripts/web.js @@ -443,6 +443,14 @@ try { console.log(`${chalk.red('ERROR!')} During about.html copying: ${err}`); process.exit(1); } +// Copy contributing.html +try { + fs.copyFileSync(path.join(staticPartsPath, 'contributing.html'), path.join(docsPath, 'contributing.html')); + console.log(`${chalk.green('SUCCESS!')} contributing.html file copied!`); +} catch (err) { + console.log(`${chalk.red('ERROR!')} During contributing.html copying: ${err}`); + process.exit(1); +} // Log the time taken console.timeEnd('Webber'); diff --git a/static-parts/contributing.html b/static-parts/contributing.html new file mode 100644 index 000000000..0bacda03e --- /dev/null +++ b/static-parts/contributing.html @@ -0,0 +1,79 @@ + + + + + + + + Contributing - 30 seconds of code + + + + + + + + + + + + + +
+

logo 30 + seconds of code + Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less. +

+
+
+
+

+

How to contribute

+

Do you have a cool idea for a new snippet? Maybe some code you use often and is not part of our collection? Contributing to 30 seconds of code is as simple as 1,2,3,4!


+

1. Create

+

Start by creating a snippet, according to the snippet template. Make sure to follow these simple guidelines:

+
    +
  • Your snippet title must be unique and the same as the name of the implemented function.
    • +
  • Use the snippet description to explain what your snippet does and how it works.
    • +
  • Try to keep the snippet's code short and to the point. Use modern techniques and features.
    • +
  • Remember to provide an example of how your snippet works.
    • +
  • Your snippet should solve a real-world problem, no matter how simple.
    • +
  • Never modify README.md or any of the HTML files.
    • +

+

2. Tag

+

Run npm run tagger from your terminal, then open the tag_database file and tag your snippet appropriately. Multitagging is also supported, just make sure the first tag you specify is on of the major tags and the one that is most relevant to the implemented function.


+

3. Test

+

You can optionally test your snippet to make our job easier. Simply run npm run tester to generate the test files for your snippet. Find the related folder for you snippet under the test directory and write some tests. Remember to run npm run tester again to make sure your tests are passing.


+

4. Pull request

+

If you have done everything mentioned above, you should now have an awesome snippet to add to our collection. Simply start a pull request and follow the guidelines provided. Remember to only submit one snippet per pull request, so that we can quickly evaluate and merge your code into the collection.


+
+ +
+ + + +