Skip to content

Commit f3cc18d

Browse files
authored
Create CONTRIBUTING.md
1 parent 8fb8012 commit f3cc18d

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Writing guidelines for PineCoders Web content
2+
3+
## Terminology
4+
5+
### Annotations
6+
Don't use the term *annotation*, as it most probably will be phased out. We use *function* for everything that was called an annotation, except for `study()` and `strategy()`, for which we use the term *declaration statement*.
7+
8+
### Realtime
9+
Use *realtime* rather than *real time* or *real-time*.
10+
11+
### Script
12+
*Script* is useful when referring to both *indicators* and *strategies*.
13+
14+
### Study vs Indicator
15+
Use *indicator* whenever you can, except when referring to the `study()` declaration statement itself.
16+
17+
Example:
18+
> The first line of an indicator should be the `study()` declaration statement.
19+
20+
Note than *indicator* is understood to include only *studies*. Pine strategies should be referred to as *strategies*—not *indicators*.
21+
22+
## Style
23+
24+
### Bulleted or enumerated lists punctuation
25+
Capitalize the first word of each element.
26+
27+
List elements use no ending punctuation when they are not a sentence. This also applies to the last element in the list.<br>
28+
Use an ending period on all list elements when they are sentences, or when the majority is.
29+
30+
### Capitalization of titles
31+
We follow the TradingView standard of capitalizing only the **first word** of titles.

0 commit comments

Comments
 (0)