mirror of
https://github.com/satwikkansal/wtfpython
synced 2024-11-22 11:04:25 +01:00
Update CONTRIBUTING.md
This commit is contained in:
parent
1c838ad896
commit
310ba05449
@ -1,33 +1,34 @@
|
|||||||
All patches are welcome. If you're ading a new example, please do create an issue before submitting a patch.
|
All patches are welcome. If you're ading a new example, please do create an issue before submitting a patch.
|
||||||
|
dcd
|
||||||
You can use the following template for adding a new example:
|
You can use the following template for adding a new example:
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
### Some fancy Title
|
||||||
|
|
||||||
|
```py
|
||||||
|
# Setting up the code.
|
||||||
|
# Preparation for the magic...
|
||||||
```
|
```
|
||||||
### Some fancy Title
|
|
||||||
|
|
||||||
```py
|
**Output (Python version):**
|
||||||
# Setting up the code.
|
```py
|
||||||
# Preparation for the magic...
|
>>> triggering_statement
|
||||||
```
|
Probably unexpected output
|
||||||
|
|
||||||
**Output (Python version):**
|
|
||||||
```py
|
|
||||||
>>> triggering_statement
|
|
||||||
Probably unexpected output
|
|
||||||
```
|
|
||||||
(Optional): One line describing the unexpected output.
|
|
||||||
|
|
||||||
**Note:** All the examples mentioned below are run on Python 3.5.2 interactive interpreter unless explicitly specified.
|
|
||||||
|
|
||||||
|
|
||||||
#### 💡 Explanation:
|
|
||||||
* Brief explanation of what's happening and why is it happening.
|
|
||||||
```py
|
|
||||||
Setting up examples for clarification (if necessary)
|
|
||||||
```
|
|
||||||
**Outupt:**
|
|
||||||
```py
|
|
||||||
>>> trigger # some example that makes it easy to unveil the magic
|
|
||||||
# some justified output
|
|
||||||
```
|
|
||||||
```
|
```
|
||||||
|
(Optional): One line describing the unexpected output.
|
||||||
|
|
||||||
|
**Note:** All the examples mentioned below are run on Python 3.5.2 interactive interpreter unless explicitly specified.
|
||||||
|
|
||||||
|
|
||||||
|
#### 💡 Explanation:
|
||||||
|
* Brief explanation of what's happening and why is it happening.
|
||||||
|
```py
|
||||||
|
Setting up examples for clarification (if necessary)
|
||||||
|
```
|
||||||
|
**Outupt:**
|
||||||
|
```py
|
||||||
|
>>> trigger # some example that makes it easy to unveil the magic
|
||||||
|
# some justified output
|
||||||
|
```
|
||||||
|
```
|
||||||
|
</pre>
|
||||||
|
Loading…
Reference in New Issue
Block a user