diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2f71982 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing to Awesome Python Scripts + +First off, thanks for taking the time to contribute! + +All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for the maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 + + +# Steps for Contribution + +## 1. Fork this repository +Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account. + +## 2. Clone the forked repository +In your cloned repository click on the **green code button** and copy the link shown. + +Clone your forked repository by running the **git clone** command with you copied link on you command line. + +```git clone ``` + +Do the following command to get into the repository directory: + +```cd ``` + +Then create your own branch in the repo using: + +```git checkout -b ``` + +## 3. Add your changes +You can see what all you changes using the `git status` command. + +## 4. Add all you changes +Add all your changes to you branch using the `git add .` command + +## 5. Push you changes to GitHub +Switch to the main branch using this command: + +```git checkout master``` + +Push all your changes to GitHub using the command: + +```git push --set-upstream origin ```