From 678d59da9a586f7543b4ca35d222221033cc1a46 Mon Sep 17 00:00:00 2001 From: Saahil Date: Tue, 18 Jun 2024 23:46:50 -0400 Subject: [PATCH] Create CONTRIBUTING.md - template --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..943f93c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing + +Your contributions are always welcome! + +## Guidelines + +* Add one link per Pull Request. + * Make sure the PR title is in the format of `Add project-name`. + * Write down the reason why the library is awesome. +* Add the link: `* [project-name](http://example.com/) - A short description ends with a period.` + * Keep descriptions concise and **short**. +* Add a section if needed. + * Add the section description. + * Add the section title to Table of Contents. +* Search previous Pull Requests or Issues before making a new one, as yours may be a duplicate. +* Don't mention `Python` in the description as it's implied. +* Check your spelling and grammar. +* Remove any trailing whitespace. + +Just a gentle reminder: **Try not to submit your own project. Instead, wait for someone finds it useful and submits it for you.**