Correct snippets main document

everget · everget · commit 837fcd99a377 · 2019-08-22T03:33:17.000+03:00
diff --git a/snippets/readme.md b/snippets/readme.md
@@ -1,7 +1,7 @@
 ![PineCoders](/images/PineCodersLong.png "PineCoders")
 
 <!-- if you need to give space before text to format tabulation use keys &ensp; &emsp; combination-->
-# Pine Script Snippets 
+# Pine Script Snippets
 
 Welcome to the list of categorized Pine Script snippets available in the PineCoders repo. The snippets are divided in thematic categories. A snippet can be either a function, a piece of code implementing a particular technique, or variable definitions.
 
@@ -10,25 +10,24 @@ Welcome to the list of categorized Pine Script snippets available in the PineCod
 > [Interested in contributing?](#instructions-to-contributors)
 
 ## Snippets by category
-<!--  -->
 
 <!-- ••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••• -->
 <!-- Data Structure Category: -->
 <details open>
   <!-- leave a blank line after summary -->
   <summary><b>Data Structure:</b></summary>
-  
+
 <details open>
   <!-- leave a blank line after summary -->
   <summary><b>&emsp;• Processing:</b></summary>
-  
+
   <!--#### &emsp;&emsp;&emsp;&emsp; -->
-######  &emsp;&emsp;&emsp; Processing and filtering of data related snippets:  
+######  &emsp;&emsp;&emsp; Processing and filtering of data related snippets:
 &emsp;&emsp;&emsp;&emsp;• [zScore - Function](/./snippets/category/data_structure/processing/zscore_function.md "Standardization using zScore.")<br/>
 </details>
 
   <!--#### &emsp; -->
-######  &emsp; Array, list, matrix, time series related snippets:  
+######  &emsp; Array, list, matrix, time series related snippets:
 &emsp;&emsp;• [Pseudo Array - Technique](/./snippets/category/data_structure/pseudo_array_technique.md "Pseudo Array - Technique.")<br/>
 </details>
 
@@ -37,13 +36,12 @@ Welcome to the list of categorized Pine Script snippets available in the PineCod
 <details open>
   <!-- leave a blank line after summary -->
   <summary><b>Math:</b></summary>
-  
 <details open>
   <!-- leave a blank line after summary -->
   <summary><b>&emsp;• Random:</b></summary>
-  
+
   <!--#### &emsp; -->
-######  &emsp;&emsp;&emsp; Randomness related snippets:  
+######  &emsp;&emsp;&emsp; Randomness related snippets:
 &emsp;&emsp;&emsp;&emsp; • [Value in a range - Function](/./snippets/category/math/random/prng_range_function.md "generate a value within range 0 to parameter.")<br/>
 &emsp;&emsp;&emsp;&emsp; • [Value using Box Muller - Function](/./snippets/category/math/random/prng_Box_Muller_function.md "generate a value with bias towards a normal distribution.")<br/>
 &emsp;&emsp;&emsp;&emsp; • [Value with bias towards a level - Function](/./snippets/category/math/random/prng_weighed_bias_function.md "generate a value with bias towards a level.")<br/>
@@ -54,35 +52,35 @@ Welcome to the list of categorized Pine Script snippets available in the PineCod
 
 
 <!-- ••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••• -->
-<!-- Miscellaneous Category: -->
+<!-- Misc Category: -->
 <details open>
   <!-- leave a blank line after summary -->
-  <summary><b>Miscellaneous:</b></summary>
-  
+  <summary><b>Misc:</b></summary>
+
   <!--#### &emsp; Miscellaneous:-->
-######  &emsp; Multiple use or unsorted snippets:  
- &emsp;&emsp; • [Nth Fibonacci](/./snippets/category/miscellaneous/nth_fibonacci.md#function-to-find-nth-fibonacci "Find the Nth Fibonacci sequence number.")
+######  &emsp; Multiple use or unsorted snippets:
+ &emsp;&emsp; • [Nth Fibonacci](/./snippets/category/misc/nth_fibonacci.md#function-to-find-nth-fibonacci "Find the Nth Fibonacci sequence number.")
 </details>
 
 <!-- ••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••• -->
 <!-- Output Category: -->
 <details open>
   <!-- leave a blank line after summary -->
   <summary><b>Output:</b></summary>
-  
+
 <details open>
   <!-- leave a blank line after summary -->
   <summary><b>&emsp;• Geometry:</b></summary>
-  
+
   <!--#### &emsp;&emsp;&emsp;&emsp; -->
-######  &emsp;&emsp;&emsp; Geometry related snippets:  
+######  &emsp;&emsp;&emsp; Geometry related snippets:
 &emsp;&emsp;&emsp;&emsp;• [Draw Rectangle - Function](/./snippets/category/output/geometry/draw_rectangle_function.md "function to draw rectangles on chart.")<br/>
 &emsp;&emsp;&emsp;&emsp;• [Draw Trapezoid - Function](/./snippets/category/output/geometry/draw_trapezoid_function.md "function to draw trapezoids on chart.")<br/>
 &emsp;&emsp;&emsp;&emsp;• [Draw Triangle - Function](/./snippets/category/output/geometry/draw_triangle_function.md "function to draw triangles on chart.")<br/>
 </details>
 
   <!--#### &emsp; -->
-######  &emsp; Output related snippets:  
+######  &emsp; Output related snippets:
 &emsp;&emsp;• [blank](/./ "blank.")<br/>
 </details>
 
@@ -91,81 +89,21 @@ Welcome to the list of categorized Pine Script snippets available in the PineCod
 <details open>
   <!-- leave a blank line after summary -->
   <summary><b>Time:</b></summary>
-  
+
 <details open>
   <!-- leave a blank line after summary -->
   <summary><b>&emsp;• Date:</b></summary>
-  
+
   <!--#### &emsp;&emsp;&emsp;&emsp; -->
-######  &emsp;&emsp;&emsp; Date related snippets:  
+######  &emsp;&emsp;&emsp; Date related snippets:
 &emsp;&emsp;&emsp;&emsp;• [Days in a month - Function](/./snippets/category/time/date/days_in_month_function.md "function to find how many days in a month.")<br/>
 </details>
 
   <!--#### &emsp; -->
-######  &emsp; Time related snippets:  
+######  &emsp; Time related snippets:
 &emsp;&emsp;• [blank](/./ "blank.")<br/>
 </details>
 
-
-<!-- ••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••• -->
-<!-- ••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••• -->
-<!-- ••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••• -->
-<!-- ••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••• -->
-<!-- ••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••• -->
-<br/>
-<br/>
-<br/>
-<br/>
-<br/>
-<br/>
-<br/>
-<details close>
-  <!-- leave a blank line after summary -->
-  <summary>Template</summary>
-  
-  #### Category A Snippets
-  Perhaps a description is usefull..
-  1. Snippet A1
-  2. Snippet A2 family:
-     * Snippet A2.1
-     * Snippet A2.2
-  3. Snippet A3
-
-<details open>
-  <!-- leave a blank line after summary -->
-  <summary>Category B</summary>
-  
-  #### Category B Snippets
-  Perhaps a description is usefull..
-  
-  ***
-  
-<details open>
-  <!-- leave a blank line after summary -->
-  <summary>Sub Category BA1</summary>
-  
-  1. Snippet SB1
-  2. Snippet SB2 family:
-     * Snippet SB2.1
-     * Snippet SB2.2
-  3. Snippet SB3
-</details>
-  
-  ***
-  
-  1. Snippet B1
-  2. Snippet B2
-  3. Snippet B3 family:
-     * Snippet B3.1
-     * Snippet B3.2
-  4. Snippet B3
-</details>
-
-</details>
-
-
-<br>
-
 ## Instructions to contributors
 
 First of all, **thank you!** &#128150;&ensp; We hope this repo becomes the de facto reference for reusable Pine code, and this will only happen with contributions like yours.
@@ -175,19 +113,25 @@ You can contribute in three ways:
 1. Do everything yourself:
     - Fork the repo.
     - Use the supplied snippet templates to format each of your snippet.
-    - Add snippet to an existing category or in the `uncategorized` category.
-    - Issue a PR.
+    - Add snippet to an existing most appropriate category (see `snippets/category`) or in the `snippets/category/misc` category.
+    - Issue a Pull Request (PR) to the main repo.
+    - Request a review from one of maintainers ([ricardosantos79](https://github.com/ricardosantos79), [LucFF](https://github.com/ricardosantos79), [everget](https://github.com/everget))
+    - Wait for review
+    - Apply the requested changes to your code if needed
 1. Supply the code through GitHub without formatting your snippet:
     - Fork the repo.
-    - Add your code in the `uncategorized` category.
-    - Issue a PR.
-1. If you are not familiar with GitHub, you can just send your code in a text file to pinecoders@gmail.com. You can use the supplied templates to format your code, but it's not mandatory.
+    - Add your code in the `snippets/category/misc` category.
+    - Issue a Pull Request (PR) to the main repo.
+    - Request a review from one of maintainers ([ricardosantos79](https://github.com/ricardosantos79), [LucFF](https://github.com/ricardosantos79), [everget](https://github.com/everget))
+    - Wait for review
+    - Apply the requested changes to your code if needed
+1. If you are not familiar with GitHub, you can just send your code in a text file to pinecoders@gmail.com. In such case it's not mandatory to use the supplied templates to format your code.
 
 We will revise and, if required, edit contributions to ensure they meet our publications standards. We will get in touch with you if we have questions.
 
 ### Notes
 - Authors are recognized in each snippet.
-- No coding conventions are mandatory. It's more important to share than to have uniform code. If you are interested in following a standard, use the [PineCoders Coding Conventions](http://www.pinecoders.com/coding_conventions).
+- We follow the idea to have uniform code for all snippets because we believe that such approach simplifies the use and sharing across users. We encourage you to follow this standard [PineCoders Coding Conventions](http://www.pinecoders.com/coding_conventions).
 - Since the repo's code is meant to be used by Pine coders of all skill levels, care should be taken to document assumptions and proper use of your snippets. The example section in each snippet is often the best way to achieve that.
 - Templates are in the `snippets/templates` directory. There is one template for each type of snippet: *function*, *technique* and *variable*.
 - Formatting inside the templates is a mix of [Markdown](https://github.com/adam-p/markdown-here/wiki) and HTML.
