mirror of
https://github.com/satwikkansal/wtfpython
synced 2024-11-22 11:04:25 +01:00
Create CONTRIBUTING.md
This commit is contained in:
parent
69d7d1e646
commit
1c838ad896
33
CONTRIBUTING.md
Normal file
33
CONTRIBUTING.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
All patches are welcome. If you're ading a new example, please do create an issue before submitting a patch.
|
||||||
|
|
||||||
|
You can use the following template for adding a new example:
|
||||||
|
|
||||||
|
```
|
||||||
|
### Some fancy Title
|
||||||
|
|
||||||
|
```py
|
||||||
|
# Setting up the code.
|
||||||
|
# Preparation for the magic...
|
||||||
|
```
|
||||||
|
|
||||||
|
**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
|
||||||
|
```
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user