Skip to content

Latest commit

 

History

History
86 lines (66 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

86 lines (66 loc) · 3.56 KB
Raw

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.

Steps to Contribute👩‍💻👨‍💻

When contributing to this repository, please first discuss the change you wish to make via raising an issue

Follow these steps to make a contribution:

📌 Step 1

Fork the repo and Go to your git terminal and clone it on your machine.

git clone https://github.com/CommunityPro/support.git

📌 Step 2

Change into the project folder, in this case (support)

cd support

📌 Step 3

Add an upstream link to main branch in your cloned repo

git remote add upstream https://github.com/CommunityPro/support.git

📌 Step 4

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/CommunityPro/support.git

📌 Step 5

Create a new branch (This is a necessary step, so don't skip it)

git checkout -b <branch-name>

📌 Step 6

Commit your changes (Make your commit short but concise. You can read best commit message practices here)

git commit -m "commit message"

📌 Step 7

Push the changes for review

git push origin <branch-name>

📌 Step 8

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 you are contributing)

Note:

  • Do not edit/delete someone else's code in this repository. You can only insert new files/folder in this repository.
  • Fix linting changes before committing.
  • Give a meaningful name to whatever file or folder you are adding.

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. Markdown Cheat-Sheet

  2. 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!💪