Skip to content

Commit cfc6c01

Browse files
bhavesh1129bhavesh1129
authored
Update Contributing.md
1 parent 1263bbe commit cfc6c01

File tree

1 file changed

+148
-30
lines changed

1 file changed

+148
-30
lines changed

‎Contributing.md

Lines changed: 148 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,161 @@
11
# Orphan Support (Web App)
22

3-
---
3+
***Where all NGO can make their profile, and people can donate/adopt children's or Abandoned parents, also people can put a report about any orphan child or Abandoned parents.***
44

5+
---
56
![GitHub custom open for collaboration](https://img.shields.io/badge/Open%20For-Collaboration-brightgreen?style=for-the-badge)
67

7-
🎉 First off, thanks for taking the time out of your schedule and deciding to contribute here! 👍
8-
9-
This repository is open for all contributions, and is accepting contributions under under [AOS 2020 (Autumn of Open Source)](http://aos.sanscript.tech/) by [Sanscript, India](https://sanscript.tech/). Any kind of updation, addition, modification and other valuable contributions are welcome.
8+
## Autumn of Open Source AOS 2020
109

11-
In case you're new to open source and contributing, be sure to read about [GitHub](https://guides.github.com/activities/hello-world/#:~:text=GitHub%20is%20a%20code%20hosting,%2C%20commits%2C%20and%20Pull%20Requests.), [GitHub Guide](https://guides.github.com/), [GitHub Open Source](https://github.com/open-source), and you are encouraged to check [OpenSource.Guide](http://opensource.guide/).
10+
<p align="center">
11+
<a href="https://sanscript.tech/">
12+
<img src="https://avatars3.githubusercontent.com/t/4187434?s=280&v=4" alt="Logo">
13+
</a>
1214

13-
Please feel free to open new issues and pull requests, wherever needed.
15+
🎉***First off, thanks for taking the time out of your schedule and deciding to contribute here!*** 👍
1416

15-
Every contribution counts, and will go a long way towards betterment of the code and/or its related files.
17+
* This repository is open for all contributions, and is accepting contributions under under [AOS 2020 (Autumn of Open Source)](http://aos.sanscript.tech/) by [Sanscript, India](https://sanscript.tech/). Any kind of updation, addition, modification and other valuable contributions are welcome.
1618

17-
### Assistance to get started
19+
* In case you're new to open source and contributing, be sure to read about [GitHub](https://guides.github.com/activities/hello-world/#:~:text=GitHub%20is%20a%20code%20hosting,%2C%20commits%2C%20and%20Pull%20Requests.), [GitHub Guide](https://guides.github.com/), [GitHub Open Source](https://github.com/open-source), and you are encouraged to check [OpenSource.Guide](http://opensource.guide/).
1820

19-
If you're new to contributing and have no idea about working with repositories, be sure to check and [start here](https://github.com/firstcontributions/first-contributions). [GitHub docs to getting started](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github) from GitHub may also be helpful to refer.
21+
* Please feel free to open new issues and pull requests, wherever needed.
2022

21-
### Steps to Contribute in GitHub Repository
23+
* Every contribution counts, and will go a long way towards betterment of the code and/or its related files.
2224

23-
To be able to contribute to this repository, be sure to fork this repository from the fork option at the top-right of [this repository](https://github.com/sanscript-tech/orphan_support-php), if not yet done. Your forked repository is from where you'll initiate (and later update, if needed) your pull requests from.
25+
## Assistance to get started
2426

25-
Go to your forked repository to add and update files for improvisation.
26-
Now, you can do this either directly from [GitHub Website](https://github.com), or by using [GitHub CLI](https://github.com/cli/cli) ([Command Line Interface](https://docs.github.com/en/github/getting-started-with-github/set-up-git)). For a better control over the contents of your forked repo, [GitHub CLI]((https://docs.github.com/en/github/getting-started-with-github/set-up-git)) is suggested.
27+
If you're new to contributing and have no idea about working with repositories, be sure to check [GitHub docs to getting started](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github) from GitHub may also be helpful to refer.
2728

28-
After cloning the repository, please read and understand what the existing code or document is meant for, before overwriting it with your changes. If you're unsure about any part, feel free to ask it in discussions, and we'd be happy to help.
29-
30-
#### Essential Guidelines for contribution against Autumn of Open Source 2020:
29+
## Essential Guidelines for contribution against Autumn of Open Source 2020:
3130

3231
Before you start off with the contribution,
3332

3433
:bulb: Be sure to look into, and adhere to these points:
3534

36-
* First comment on the opened issues on which you want to work as "Can I take up the work ?", "I would like to work on this!", etc. :loudspeaker:
35+
* First comment on the opened issues on which you want to work as "Can I take up the work ?","I would like to work on this!",etc.:loudspeaker:
36+
37+
* Wait for ***approval***. After it's assigned to you then move on further, fork the repository and clone it (if haven't yet done) and start your work according to the guidelines given in the [README.md](https://github.com/sanscript-tech/orphan_support-php/blob/main/README.md) of repository.
38+
39+
## Steps to Contribute in GitHub Repository
40+
41+
***If you don't have git on your machine, [install it](https://help.github.com/articles/set-up-git/).***
42+
43+
### 1. Fork this repository 🚀
44+
45+
Fork this repository by clicking on the fork button on the top of this page.
46+
<p align="center">
47+
<img src="https://raw.githubusercontent.com/bhavesh1129/orphan_support-php/main/assets/img/fork.png"/>
48+
</a>
49+
50+
This will create a copy of this repository in your account.
51+
52+
### 2. Clone the repository 🏁
53+
54+
* Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon.
55+
56+
* After cloning the repository, please read and understand what the existing code or document is meant for, before overwriting it with your changes. If you're unsure about any part, feel free to ask it in discussions, and we'd be happy to help.
57+
<p align="center">
58+
<img src="https://raw.githubusercontent.com/bhavesh1129/orphan_support-php/main/assets/img/clone.png">
59+
</a>
60+
61+
* Open a terminal and run the following git command:
62+
63+
```
64+
git clone "url you just copied"
65+
```
66+
67+
where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.
68+
69+
70+
For example:
71+
72+
```
73+
git clone https://github.com/sanscript-tech/orphan_support-php.git
74+
```
75+
76+
77+
78+
79+
### 3. Create a branch ⚓
80+
81+
Change to the repository directory on your computer (if you are not already there):
82+
83+
```
84+
cd (filename)
85+
```
86+
87+
Now create a branch using the `git checkout` command:
88+
89+
```
90+
git checkout -b your-new-branch-name
91+
```
92+
93+
For example:
94+
95+
```
96+
git checkout -b dev_username
97+
```
98+
99+
### 4. Make necessary changes and commit those changes 🚏
100+
101+
Do the necessary changes.
102+
103+
If you go to the project directory and execute the command `git status`, you'll see there are changes.
104+
105+
Add those changes to the branch you just created using the `git add` command:
106+
107+
<p align="center">
108+
<img src="https://raw.githubusercontent.com/bhavesh1129/orphan_support-php/main/assets/img/Add.png">
109+
</a>
110+
111+
```
112+
git add .
113+
```
114+
115+
Now commit those changes using the `git commit` command:
116+
117+
<p align="center">
118+
<img src="https://raw.githubusercontent.com/bhavesh1129/orphan_support-php/main/assets/img/Commit.png">
119+
</a>
120+
121+
```
122+
git commit -m "(Add your message here)"
123+
```
124+
125+
replacing `<Add your message here>` with your message.
126+
127+
### 5. Push changes to GitHub 🪂
128+
129+
Push your changes using the command `git push`:
130+
131+
<p align="center">
132+
<img src="https://raw.githubusercontent.com/bhavesh1129/orphan_support-php/main/assets/img/push.png">
133+
</a>
134+
135+
```
136+
git push origin <branch-name>
137+
```
138+
139+
replacing `<branch-name>` with the name of the branch you created earlier.
140+
141+
### 6. Submit your changes for review 🚩
142+
143+
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
144+
145+
<p align="center">
146+
<img src="https://raw.githubusercontent.com/bhavesh1129/orphan_support-php/main/assets/img/compare.png">
147+
</a>
148+
149+
Now submit the pull request.
150+
151+
<p align="center">
152+
<img src="https://raw.githubusercontent.com/bhavesh1129/orphan_support-php/main/assets/img/pullrequest.png">
153+
</a>
154+
155+
Soon we will be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged.
37156

38-
* Wait for approval. After it's assigned to you then move on further, fork the repository and clone it (if haven't yet done) and start your work according to the guidelines given in the [README.md](https://github.com/sanscript-tech/orphan_support-php/blob/main/README.md) of repository.
39157

40-
#### More Contribution Guidelines :guard:
158+
## More Contribution Guidelines :guard::page_with_curl:
41159

42160
1. Issues will be assigned on a first come first serve basis.
43161
2. Maximum two active issues can be assigned to a single individual.
@@ -50,31 +168,31 @@ Before you start off with the contribution,
50168
9. Add a "requirements.txt" file that enlists the program requirements, in case dependencies are required.
51169
10. Perform a self-review before submitting the PR and wait for the mentors to review it and merge.
52170

53-
:ribbon: **Please go through the following essential steps for successfully submitting a PR (Pull Request) here:** :rocket:
171+
### :ribbon: **Please go through the following essential steps for successfully submitting a Pull Request here:** :rocket:
54172

55-
1. Star (Optional, will help you stay up-to-date about the later changes in the base repository) and Fork this repository. :checkered_flag:
173+
1. Star :star: (Optional, will help you stay up-to-date about the later changes in the base repository) and Fork this repository. :checkered_flag:
56174

57175
2. Clone it :globe_with_meridians: using command `git clone <Your_Forked_Repo_URL_Here>` in your CLI. This will download and save a folder for your existing repository, locally in your machine.
58176

59177
3. Switch to a branch using `git checkout -b <branchName>`, in which you are required to work (usually it is 'main' or 'master', but for our cases, it'll be "dev_username". In place of username, mention your GitHub username). Remember, do not directly checkout from 'master' branch of your forked repository.
60178

61179
4. Check existing files, and make your desired updations.
62180

63-
5. Open a command prompt/terminal in the same directory and enter `git add .` or `git add -A`. This adds all the files for tracking and will be including them in the next commit.
181+
5. Open a command prompt/terminal :man_technologist: in the same directory and enter `git add .` or `git add -A`. This adds all the files for tracking and will be including them in the next commit.
64182

65-
6. Commit your changes with `git commit -m "<Your One-Liner Commit Message>"`. In place of message, put a valuable and meaningful message so that it is easier for us to understand the changes you have done. This commits your changes locally.
183+
6. Commit your changes :memo: with `git commit -m "<Your One-Liner Commit Message>"`. In place of message, put a valuable and meaningful message so that it is easier for us to understand the changes you have done. This commits your changes locally.
66184

67185
7. Use `git pull -u` or `git pull --set-upstream origin <branchName>` (The `-u` or `--set-upstream` flag only needs to be used in the first time. For later use, `git pull` can be used without any additional flags). This pulls any further changes from the server and ensures that the local branch is again up-to-date with the remote server.
68186

69-
8. Push your changes to remote server using `git push` or `git push origin <branchName>`. This pushes your changes to the repository.
187+
8. Push your changes :arrow_up: to remote server using `git push` or `git push origin <branchName>`. This pushes your changes to the repository.
70188

71189
After following these steps in Git CLI (in order), you'll need to go to your GitHub repository in the website to initiate a new Pull Request. Now create a pull request by comparing 'dev_username' branch of your forked repository with 'master' branch of this upstream repository. :confetti_ball:
72190

73-
:trophy: After this, project leaders and mentors will review the changes and will merge your PR if they are found good, otherwise we will suggest the required changes.
191+
***:trophy: After this, project leaders and mentors will review the changes and will merge your PR if they are found good, otherwise we will suggest the required changes.***
74192

75-
### Style Guides for Git Commit Messages
193+
## Style Guides for Git Commit Messages:memo:
76194

77-
Here's a list of some good to have points, that can add more value to your contribution logs.
195+
#### Here's a list of some good to have points, that can add more value to your contribution logs.
78196

79197
- Use the present tense (example: "Add feature" and not "Added feature")
80198
- Use the imperative mood (example: "Move item to...", instead of "Moves item to...")
@@ -83,12 +201,12 @@ Here's a list of some good to have points, that can add more value to your contr
83201
- Separate subject from body with a blank line
84202
- Do not end the subject line with a period
85203
- Wrap the body at 72 characters
86-
- Use the body to explain what and why vs. how
204+
- Use the body to explain what, why, vs, and how
87205
- Reference issues and pull requests liberally after the first line
88206

89207
For more detailed reference to the above points, refer here: [https://chris.beams.io/posts/git-commit/].
90208

91209

92-
So, what are you waiting for? Begin contributing now! :fire: :rocket:
210+
### So, what are you waiting for? Begin contributing now! :fire: :rocket:
93211

94-
All the Best! 🥇
212+
#### All the Best!🥇

0 commit comments

Comments
 (0)