|
1 | 1 |  |
2 | 2 |
|
3 | 3 | <!-- if you need to give space before text to format tabulation use keys     combination--> |
4 | | -# Snippets |
| 4 | +# Pine Script Snippets |
5 | 5 |
|
6 | | -## Code Snippets for Tradingview Pine Script language: |
7 | | -Snippets categorized by purpose. |
| 6 | +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. |
| 7 | + |
| 8 | +**To access a snippet, just click on its name.** |
| 9 | + |
| 10 | +> [Interested in contributing?](#instructions-to-contributors) |
| 11 | + |
| 12 | +## Snippets by category |
8 | 13 | <!-- --> |
9 | 14 |
|
10 | 15 | <!-- ••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••• --> |
@@ -157,3 +162,35 @@ Snippets categorized by purpose. |
157 | 162 | </details> |
158 | 163 |
|
159 | 164 | </details> |
| 165 | + |
| 166 | + |
| 167 | +<br> |
| 168 | + |
| 169 | +## Instructions to contributors |
| 170 | + |
| 171 | +First of all, **thank you!** 💖  We hope this repo becomes the de facto reference for reusable Pine code, and this will only happen with contributions like yours. |
| 172 | + |
| 173 | +You can contribute in three ways: |
| 174 | + |
| 175 | +1. Do everything yourself: |
| 176 | + - Fork the repo. |
| 177 | + - Use the supplied snippet templates to format each of your snippet. |
| 178 | + - Add snippet to an existing category or in the `uncategorized` category. |
| 179 | + - Issue a PR. |
| 180 | +1. Supply the code through GitHub without formatting your snippet: |
| 181 | + - Fork the repo. |
| 182 | + - Add your code in the `uncategorized` category. |
| 183 | + - Issue a PR. |
| 184 | +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. |
| 185 | + |
| 186 | +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. |
| 187 | + |
| 188 | +### Notes |
| 189 | +- Authors are recognized in each snippet. |
| 190 | +- 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). |
| 191 | +- 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. |
| 192 | +- Templates are in the `snippets/templates` directory. There is one template for each type of snippet: *function*, *technique* and *variable*. |
| 193 | +- Formatting inside the templates is a mix of [Markdown](https://github.com/adam-p/markdown-here/wiki) and HTML. |
| 194 | +- Version 4 code is preferred. The templates allow for multiple versions of your snippets. |
| 195 | + |
| 196 | +**[Back to top](#pine-script-snippets)** |
0 commit comments