mirror of
https://github.com/satwikkansal/wtfpython.git
synced 2024-09-11 20:17:08 +03:00
Add few pointers for contributing well
This commit is contained in:
parent
c5665da81d
commit
03719dea45
7
CONTRIBUTING.md
vendored
7
CONTRIBUTING.md
vendored
@ -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).
|
Loading…
Reference in New Issue
Block a user