mirror of
https://github.com/hastagAB/Awesome-Python-Scripts.git
synced 2024-11-27 14:01:09 +00:00
3ff827164f
* Create CONTRIBUTING.md * Delete CONTRIBUTING.md * Create CONTRIBUTING.md
42 lines
1.4 KiB
Markdown
42 lines
1.4 KiB
Markdown
# 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 <url_you_just_copied>```
|
|
|
|
Do the following command to get into the repository directory:
|
|
|
|
```cd <your_directory>```
|
|
|
|
Then create your own branch in the repo using:
|
|
|
|
```git checkout -b <your_branch_name>```
|
|
|
|
## 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 <your_branch_name>```
|