Skip to content

Commit

Permalink
Add few pointers for contributing well
Browse files Browse the repository at this point in the history
  • Loading branch information
satwikkansal committed Sep 13, 2019
1 parent c5665da commit 03719de
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -36,3 +36,10 @@ Probably unexpected output
```
```
</pre>


Few things that you can consider while writing an example,

- 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.
- 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.
- Also, please don't forget to add your name to the [contributors list](/CONTRIBUTING.md).

0 comments on commit 03719de

Please sign in to comment.