Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 4.03 KB

CONTRIBUTING_GUIDELINES.md

File metadata and controls

82 lines (56 loc) · 4.03 KB

Contributing Guidelines🙌

This documentation contains a set of guidelines to help you during the contribution process. I'm happy to welcome all the contributions from anyone willing to add new scripts to this repository. Thank you for helping out and remember, no contribution is too small.

Template✔

Before starting your contribution, kindly go through this template that needs to be followed for merging your PR successfully.

  • Create a folder with a meaningful repository name (If it's a hello world program, repository should look something like "HelloWorld" and file name as Hello_World.py)

  • Repository should include a File_Name.py, README.md and other related files (if any)

  • If there are any requirements or pre-requisites needed, do state them in requirements.txt file

  • The README.md file should be concise and clear about what the project is about and what it does

  • It should be documented briefly enough to let readers understand. Screenshot inclusion is must

Steps to Contribute👩‍💻👨‍💻

Following are the steps to guide you:

  • Step 1: Fork the repo and Go to your Git terminal and clone it on your machine.
  • Step 2: Add a upstream link to main branch in your cloned repo 
    git remote add upstream https://github.com/prathimacode-hub/Awesome_Python_Scripts.git
  • Step 3: Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes) 
    git pull upstream main https://github.com/prathimacode-hub/Awesome_Python_Scripts.git
  • Step 4: Create your feature branch (This is a necessary step, so don't skip it) 
    git checkout -b <feature-name>
  • Step 5: Commit all the changes (Write commit message as "Small Message") 
    git commit -m "Write a meaningfull but small commit message"
  • Step 6: Push the changes for review 
    git push origin <branch-name>
  • Step 7: Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)

##Note:🔨

  • Do not edit/delete someone else's code in this repository. You can only insert new files/folder in this repository.
  • Give a meaningful name to whatever file or folder you are adding, for e.g., if you have written a Python code on hello world, then hello_world.py is one example of valid name.

What should I keep in mind while contributing?💡

  • When you are contributing, make sure that the work is entirely your own and not from some other source.
  • All the scripts must follow PEP 8 Style Guidelines.

Resources📖

  1. Markdown : Markdown is a lightweight markup language like HTML, with plain text formatting syntax.
  1. Git : Git is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.

Need more help?🤔

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

Tip from me😇

It always takes time to understand and learn. So, do not worry at all. I know you have got this!💪