Skip to content

Commit 03719de

Browse files
committed
Add few pointers for contributing well
1 parent c5665da commit 03719de

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,10 @@ Probably unexpected output
3636
```
3737
```
3838
</pre>
39+
40+
41+
Few things that you can consider while writing an example,
42+
43+
- Try to be consistent with the namings and the values you use with the variables. For instance, most variable names in the project are along the lines of `some_string`, `some_list`, `some_dict`, etc. You'd see a lot of `x`s for single letter variable names, and `"wtf"` as values for strings. There's strictly enforced scheme in the project, but you can take a glance at other examples to get a gist.
44+
- Try to be as creative as possible to add that element of "surprise" in the setting up part of an example. Sometimes this may mean writing a snippet a sane programmer would never write.
45+
- Also, please don't forget to add your name to the [contributors list](/CONTRIBUTING.md).

0 commit comments

Comments
 (0)