|
1 | | -# Contributing Guidelines |
| 1 | +# 🚀 Contributing Guidelines 🌟 |
2 | 2 |
|
3 | | -This documentation contains a set of guidelines to help you during the contribution process. |
4 | | -We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. |
5 | | -Thank you for helping out and remember, **no contribution is too small.** |
| 3 | +Welcome to the exciting world of open-source contributions! 🎉 We're thrilled that you want to be a part of our project, and we appreciate your efforts to make it even better. Remember, in our world, there's no such thing as a contribution that's too small! 🌈 |
6 | 4 |
|
| 5 | +## 🤔 Need Help with the Basics? 🧐 |
7 | 6 |
|
8 | | -## Need some help regarding the basics?🤔 |
| 7 | +Don't worry if you're new to Git and GitHub; we've got your back! Here are some resources to help you get started: |
9 | 8 |
|
| 9 | +- 🍴 [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) |
| 10 | +- 🚀 [Creating Your First Pull Request](https://opensource.com/article/19/7/create-pull-request-github) |
| 11 | +- 💻 [Getting Started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) |
10 | 12 |
|
11 | | -You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, |
12 | | -in case you are stuck: |
| 13 | +If you ever feel lost, don't hesitate to reach out to our fantastic project mentors. They're here to help! 🌟 |
13 | 14 |
|
14 | | -- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) |
15 | | -- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) |
16 | | -- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) |
17 | | -- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) |
18 | | -- [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github) |
| 15 | +## 👩💻 Submitting Contributions |
19 | 16 |
|
20 | | -## Submitting Contributions👩💻👨💻 |
| 17 | +Let's get down to business! Here's how you can submit your contributions and join the fun: |
21 | 18 |
|
22 | | -Below you will find the process and workflow used to review and merge your changes. |
| 19 | +### 🔍 Step 1: Find an Issue |
23 | 20 |
|
24 | | -### Step 0 : Find an issue |
25 | | - |
26 | | -- Take a look at the Existing Issues or create your **own** Issues! |
27 | | -- Wait for the Issue to be assigned to you after which you can start working on it. |
28 | | -- Note : Every change in this project should/must have an associated issue. |
| 21 | +- Dive into our existing issues, or if you're feeling adventurous, create one yourself! |
| 22 | +- We'll assign an issue to you, so hang tight and wait for the green light. 🚦 |
| 23 | +- Remember, every change you make in this project should have an associated issue. |
29 | 24 |
|
30 | 25 |  |
31 | 26 |
|
| 27 | +### 🍽️ Step 2: Fork the Project |
32 | 28 |
|
33 | | -### Step 1 : Fork the Project |
34 | | - |
35 | | -- Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. |
36 | | -Keep a reference to the original project in `upstream` remote. |
| 29 | +- Fork this Repository. It's like making a copy of your favorite dish, but for code! 🍴 |
| 30 | +- Keep a reference to the original project in the `upstream` remote. Here's how to do it: |
37 | 31 |
|
38 | 32 | ```bash |
39 | | -git clone https://github.com/<your-username>/<repo-name> |
40 | | -cd <repo-name> |
41 | | -git remote add upstream https://github.com/<upstream-owner>/<repo-name> |
42 | | -``` |
43 | | - |
44 | | - |
| 33 | +git clone https://github.com/<your-username>/<repo-name> |
| 34 | +cd <repo-name> |
| 35 | +git remote add upstream https://github.com/<upstream-owner>/<repo-name> |
| 36 | +``` |
45 | 37 |
|
| 38 | + |
46 | 39 |
|
47 | | -- If you have already forked the project, update your copy before working. |
| 40 | +- If you've already forked the project, update your copy with these commands: |
48 | 41 |
|
49 | 42 | ```bash |
50 | 43 | git remote update |
51 | 44 | git checkout <branch-name> |
52 | 45 | git rebase upstream/<branch-name> |
53 | | -``` |
| 46 | +``` |
54 | 47 |
|
55 | | -### Step 2 : Branch |
| 48 | +### 🌿 Step 3: Branch Out |
56 | 49 |
|
57 | | -Create a new branch. Use its name to identify the issue your addressing. |
| 50 | +- Create a new branch to work on your contribution. The branch name should reflect the issue you're addressing. |
58 | 51 |
|
59 | 52 | ```bash |
60 | | -# It will create a new branch with name Branch_Name and switch to that branch |
| 53 | +# Create a branch and switch to it |
61 | 54 | git checkout -b branch_name |
62 | 55 | ``` |
63 | 56 |
|
64 | | -### Step 3 : Work on the issue assigned |
| 57 | +### 💼 Step 4: Work Your Magic |
65 | 58 |
|
66 | | -- Work on the issue(s) assigned to you. |
67 | | -- Add all the files/folders needed. |
68 | | -- After you've made changes or made your contribution to the project add changes to the branch you've just created by: |
| 59 | +- Roll up your sleeves and work on the issue assigned to you. 🧙♂️ |
| 60 | +- Add all the necessary files and code changes. |
69 | 61 |
|
70 | | -```bash |
71 | | -# To add all new files to branch Branch_Name |
72 | | -git add . |
73 | | -# To add only a few files to Branch_Name |
| 62 | +```bash |
| 63 | +# Add all your new files to the branch |
| 64 | +git add . |
| 65 | +# Or, if you prefer, add only specific files |
74 | 66 | git add <some files> |
75 | 67 | ``` |
76 | 68 |
|
77 | | -### Step 4 : Commit |
| 69 | +### ✍️ Step 5: Commit Your Work |
78 | 70 |
|
79 | | -- To commit give a descriptive message for the convenience of reviewer by: |
| 71 | +- Leave a helpful and descriptive message for the reviewer. Think of it as the secret ingredient in your recipe for a great contribution. |
80 | 72 |
|
81 | 73 | ```bash |
82 | | -# This message get associated with all files you have changed |
83 | | -git commit -m "message" |
| 74 | +# This message is your legacy; make it count |
| 75 | +git commit -m "message" |
84 | 76 | ``` |
85 | 77 |
|
86 | | -- **NOTE**: A PR should have only one commit. Multiple commits should be squashed. |
| 78 | +- **NOTE**: Each Pull Request (PR) should ideally contain only one commit. Multiple commits should be squashed into one for a cleaner history. |
87 | 79 |
|
88 | | -### Step 5 : Work Remotely |
| 80 | +### 🌍 Step 6: Share Your Brilliance |
89 | 81 |
|
90 | | -- Now you are ready to your work to the remote repository. |
91 | | -- When your work is ready and complies with the project conventions, upload your changes to your fork: |
| 82 | +- Now it's time to share your work with the world. Upload your changes to your forked repository: |
92 | 83 |
|
93 | | -```bash |
94 | | -# To push your work to your remote repository |
| 84 | +```bash |
| 85 | +# Push your work to your remote repository |
95 | 86 | git push -u origin Branch_Name |
96 | 87 | ``` |
97 | 88 |
|
98 | | -- Here is how your branch will look. |
99 | | - |
| 89 | +- Your branch will look as awesome as this: |
100 | 90 |
|
| 91 | + |
101 | 92 |
|
102 | | -### Step 6 : Pull Request |
| 93 | +### 🎯 Step 7: The Grand Finale - Pull Request |
103 | 94 |
|
104 | | -- Go to your repository in browser and click on compare and pull requests. |
105 | | -Then add a title and description to your pull request that explains your contribution. |
| 95 | +- Hop over to your repository on your web browser and click on "compare and pull requests." |
| 96 | +- Add a title and description to your pull request to tell the world about your brilliant contribution. 🌟 |
106 | 97 |
|
107 | 98 |  |
108 | 99 |
|
109 | | -- Yay, Your Pull Request has been submitted and will be reviewed by the moderators and merged. |
110 | | - |
| 100 | +- Ta-da! Your Pull Request is submitted and will be reviewed by our fantastic moderators. Expect it to be merged with confetti and applause! 🎉🎉 |
111 | 101 |
|
| 102 | +Remember, every small step you take makes this project better, and we're grateful for your contribution. So, let's cook up something amazing together! 🍽️🚀 |
0 commit comments