Skip to content

Commit 310ba05

Browse files
authored
Update CONTRIBUTING.md
1 parent 1c838ad commit 310ba05

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,34 @@
11
All patches are welcome. If you're ading a new example, please do create an issue before submitting a patch.
2-
2+
dcd
33
You can use the following template for adding a new example:
44

5+
<pre>
6+
### Some fancy Title
7+
8+
```py
9+
# Setting up the code.
10+
# Preparation for the magic...
511
```
6-
### Some fancy Title
712

13+
**Output (Python version):**
14+
```py
15+
>>> triggering_statement
16+
Probably unexpected output
17+
```
18+
(Optional): One line describing the unexpected output.
19+
20+
**Note:** All the examples mentioned below are run on Python 3.5.2 interactive interpreter unless explicitly specified.
21+
22+
23+
#### 💡 Explanation:
24+
* Brief explanation of what's happening and why is it happening.
825
```py
9-
# Setting up the code.
10-
# Preparation for the magic...
26+
Setting up examples for clarification (if necessary)
1127
```
12-
13-
**Output (Python version):**
28+
**Outupt:**
1429
```py
15-
>>> triggering_statement
16-
Probably unexpected output
30+
>>> trigger # some example that makes it easy to unveil the magic
31+
# some justified output
1732
```
18-
(Optional): One line describing the unexpected output.
19-
20-
**Note:** All the examples mentioned below are run on Python 3.5.2 interactive interpreter unless explicitly specified.
21-
22-
23-
#### 💡 Explanation:
24-
* Brief explanation of what's happening and why is it happening.
25-
```py
26-
Setting up examples for clarification (if necessary)
27-
```
28-
**Outupt:**
29-
```py
30-
>>> trigger # some example that makes it easy to unveil the magic
31-
# some justified output
32-
```
3333
```
34+
</pre>

0 commit comments

Comments
 (0)