Skip to content

Commit e2ca986

Browse files
Merge pull request sahil-sagwekar2652#129 from silky-modi22/contrinution_file
Update Contributing.md file
2 parents 13a1c3f + 5299553 commit e2ca986

File tree

1 file changed

+44
-10
lines changed

1 file changed

+44
-10
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
# Contributing to GitHub-Automation-Scripts
2-
3-
First off, thanks for taking the time to contribute! ❤️
4-
5-
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
2+
Ah, thank you ever so much for gracing us with your oh-so-valuable contributions! We're just thrilled to have you here.
3+
But wait, hold on! Don't just dive in and contribute your precious time. First, read the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
64

75
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
86
> - Star the project
97
> - Tweet about it
10-
8+
Remember, every bit of support, big or small, makes a significant difference, and we truly appreciate every gesture of encouragement you offer. Your appreciation fuels our passion for the project, and we're immensely grateful for your involvement in any form! ❤️🌟🐦
119

1210
## Table of Contents
1311

@@ -30,14 +28,50 @@ If you still feel the need to ask a question and need clarification, we recommen
3028

3129
## How To Contribute
3230

33-
- Fork the project on GitHub, clone it on your PC.
31+
To start contributing, follow the guidelines given below:
32+
33+
### 1. Fork the Repository
34+
Fork the repository (https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts)
35+
36+
### 2. Clone the forked Repository
37+
```
38+
git clone https://github.com/<your_user_name>/GitHub-Automation-scripts.git
39+
```
40+
***NOTE***
3441
- If you have an idea for an enhancement or a bug you can first check the [Issues](https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts.git/issues) to see if your question has been asked before.
42+
3543
- If you'd like to work on an issue, please ask the creator of the issue to assign it to you. This helps to keep the workflow streamlined.
36-
- Create a new branch for your contribution and make the changes you want to make. (Always check for updates on the main branch before creating a pull request to avoid merge conflicts.)
44+
45+
### 3. Create a New Branch
46+
```
47+
git checkout -b <your_branch_name>
48+
```
49+
## Making Changes
50+
Perform your desired changes to the code base.
51+
52+
### 4. Track Changes
53+
```
54+
git add .
55+
```
56+
57+
### 5. Commit Changes
58+
```
59+
git commit -m "Suitable message"
60+
```
61+
62+
### 6. Push Changes
63+
```
64+
git push -u origin <your_branch_name>
65+
```
66+
67+
## Creating a Pull Request
68+
To create a pull request:
69+
3770
- The pull request should mention the issue it is trying to solve and should be linked to it. Here is a video on how to link PRs to issues - [video link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
38-
- Make sure to make the appropriate changes in the README.md file if you are adding a new script or feature.
3971

72+
- Make sure to make the appropriate changes in the README.md file if you are adding a new script or feature.
73+
- Add an appropriate title and description to your pull request, explaining your changes with suitable explanations and screenshots 📝🖼️
74+
- Click on "Create Pull Request" to submit your contribution for review ✅
4075

4176
## Styleguides
42-
43-
This project uses the Flake8 linter to lint the Python code. If you are using VSCode, I would suggest installing the [Flake8 linter extension](https://marketplace.visualstudio.com/items?itemName=ms-python.flake8) for VSCode.
77+
This project uses the Flake8 linter to lint the Python code. If you are using VSCode, I would suggest installing the [Flake8 linter extension](https://marketplace.visualstudio.com/items?itemName=ms-python.flake8) for VSCode.

0 commit comments

Comments
 (0)