Update contributing guidelines

This commit is contained in:
Satwik Kansal 2018-01-22 14:42:35 +05:30
parent a253ec4cda
commit 3b956caba2
2 changed files with 4 additions and 7 deletions

7
CONTRIBUTING.md vendored
View File

@ -1,4 +1,4 @@
All patches are welcome. Feel free to even suggest some catch and funny titles for the existing Examples. I really want to make this collection as interesting to read as possible.
All kinds of patches are welcome. Feel free to even suggest some catchy and funny titles for the existing Examples. The goal is to make this collection as interesting to read as possible.
If the changes you suggest are siginificant, filing an issue before submitting the actual patch will be appreciated. If you'd like to work on the issue (highly encouraged), you can mention that you're interested in working on it while creating the issue and get assigned to it.
@ -7,7 +7,7 @@ If you're adding a new example, please do create an issue to discuss it before s
You can use the following template for adding a new example:
<pre>
### Some fancy Title
### Some fancy Title
```py
# Setting up the code.
@ -21,9 +21,6 @@ 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

4
README.md vendored
View File

@ -2318,9 +2318,9 @@ Trying to come up with an example that combines multiple examples discussed abov
# Contributing
All patches are Welcome! Filing an [issue](https://github.com/satwikkansal/wtfpython/issues/new) first before submitting a patch will be appreciated :) Please see [CONTRIBUTING.md](/CONTRIBUTING.md) for further details.
All patches are Welcome! Please see [CONTRIBUTING.md](/CONTRIBUTING.md) for further details.
For discussions, either create a new [issue](https://github.com/satwikkansal/wtfpython/issues/new) or ping on the Gitter [channel](https://gitter.im/wtfpython/Lobby)
For discussions, you can either create a new [issue](https://github.com/satwikkansal/wtfpython/issues/new) or ping on the Gitter [channel](https://gitter.im/wtfpython/Lobby)
# Acknowledgements