From 1c838ad896389423f4c552278a2838f92dcf6e01 Mon Sep 17 00:00:00 2001 From: Satwik Kansal Date: Thu, 31 Aug 2017 19:11:20 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d78081e --- /dev/null +++ b/CONTRIBUTING.md @@ -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 + ``` +```