Update CONTRIBUTING.md

This commit is contained in:
Satwik Kansal 2017-08-31 19:13:00 +05:30 committed by GitHub
parent 1c838ad896
commit 310ba05449
1 changed files with 28 additions and 27 deletions

View File

@ -1,33 +1,34 @@
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:
<pre>
### Some fancy Title
```py
# Setting up the code.
# Preparation for the magic...
```
### 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
```
**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
```
```
</pre>