CONTRIBUTING.md

Contributing ✨

When contributing to this repository, please first discuss the change you wish to make via issue. We have created some templates that you may use.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Issue Process

1. Ensure there is no existing duplicate Issue
2. Use Issue Templates
3. Only make PRs for the Issue assigned to you

Pull Request Process

1. Only make PRs for the Issue assigned to you
2. Lint your code using flake8
3. Use PR Template
4. Read CONTRIBUTE

Steps required to follow before adding any script

• Make a separate folder for your script.

• There shouldn't be any spaces between the names of the script. (Use underscore or dash Symbol)

  • ❌ Script One
  • ✔️ Script_One
  • ✔️ Script-One

• The Folder should contain the followings -

  • Main Python Script,
  • Supporting files for the Script (If any)
  • A separate README.md File with proper documentation
  • requirementsz.txt file for any required library.
  • How to create requirements.txt file - cd <your_script_dir> - Activate your local virtual environment - source env\bin\activate - pip freeze > requirements.txt
  • Learn about Virtual Environment

• Only One Commit per PR is Adviced.

Need some help regarding the basics?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:

• Forking a Repo
• Cloning a Repo
• How to create a Pull Request
• Getting started with Git and GitHub
• Learn GitHub from Scratch

🌟 Star it 🍴Fork it 🤝 Contribute to it!

Discord server - http://pragmaticprogrammer.in/discord

Happy Coding 💜