Skip to content

Commit 7809170

Browse files
authored
Update Contribution.md
1 parent 0157195 commit 7809170

1 file changed

Lines changed: 138 additions & 0 deletions

File tree

Contribution.md

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,139 @@
1+
<img src="assets/images/logo.png" align="right" alt="Image" height="100" width="100" />
12

3+
# AapKaVaidya -Swaasth Ek Jaroorat:stethoscope::drop_of_blood:
4+
5+
### About the Project✍
6+
7+
- A flutter based application for easy interaction between patient's and doctors. During Pandemic many of the patients are looking to get a regular health check-ups but moving outside in such conditions seems risky.
8+
9+
- So the application is build for this problem, it consists of chatbox with realtime database , login/signup page using firebase google signin and email/password sigin/signup, cool animations using rive , covid tracker with realtime updates , a tracker for nearby ambulance, also addon to this there is a relax zone which comprises of mini games and music to chill out.
10+
11+
- The app uses YouTube API to call the videoplayer to get indulge in streaming youtube videos there, nearby locations of hospitals is also set using Google Map API.
12+
<hr><br>
13+
14+
🎉**First off, thanks for taking the time out of your schedule and deciding to contribute here!** 👍
15+
16+
* 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/).
17+
18+
* Please feel free to open new issues and pull requests, wherever needed.
19+
20+
* Every contribution counts, and will go a long way towards betterment of the code and/or its related files.
21+
<hr>
22+
23+
## Steps to Contribute in GitHub Repository:pushpin:
24+
25+
***If you don't have git on your machine, [install it](https://help.github.com/articles/set-up-git/).***
26+
27+
### 1. Fork this repository 🚀
28+
29+
* Fork this repository by clicking on the fork button on the top of this page.
30+
<p align="center">
31+
<img src="https://raw.githubusercontent.com/bhavesh1129/orphan_support-php/main/assets/img/fork.png"/>
32+
</a>
33+
34+
* This will create a copy of this repository in your account.
35+
36+
### 2. Clone the repository 🏁
37+
38+
* 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.
39+
40+
* 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.
41+
42+
* Open a terminal and run the following git command:
43+
44+
```
45+
git clone "url you just copied"
46+
```
47+
<p align="center">
48+
<img src="https://github.com/bhavesh1129/AapKaVaidya/blob/master/Contributing%20File%20Images/clone.png" height="300px" width="350px">
49+
</p>
50+
51+
### 3. Create a branch ⚓
52+
53+
* Change to the repository directory on your computer (if you are not already there):
54+
55+
```
56+
cd (filename)
57+
```
58+
<p align="center">
59+
<img src="https://github.com/bhavesh1129/AapKaVaidya/blob/master/Contributing%20File%20Images/cd.png">
60+
</p>
61+
62+
* Now create a branch using the `git checkout` command:
63+
64+
```
65+
git checkout -b your-new-branch-name
66+
```
67+
<p align="center">
68+
<img src="https://github.com/bhavesh1129/AapKaVaidya/blob/master/Contributing%20File%20Images/checkout.png">
69+
</p>
70+
71+
### 4. Make necessary changes and commit those changes 🚏
72+
73+
* Do the necessary changes.
74+
75+
* Add those changes to the branch you just created using the `git add .` command:
76+
77+
```
78+
git add .
79+
```
80+
<p align="center">
81+
<img src="https://github.com/bhavesh1129/AapKaVaidya/blob/master/Contributing%20File%20Images/add.png">
82+
</p>
83+
84+
* Now commit those changes using the `git commit` command:
85+
86+
```
87+
git commit -m "(Add your message here)"
88+
```
89+
<p align="center">
90+
<img src="https://github.com/bhavesh1129/AapKaVaidya/blob/master/Contributing%20File%20Images/commit.png">
91+
</p>
92+
93+
### 5. Push changes to GitHub 🪂
94+
95+
* Push your changes using the command `git push`:
96+
97+
```
98+
git push -u origin <branch-name>
99+
```
100+
<p align="center">
101+
<img src="https://github.com/bhavesh1129/AapKaVaidya/blob/master/Contributing%20File%20Images/push.png">
102+
</p>
103+
104+
### 6. Submit your changes for review 🚩
105+
106+
* If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
107+
108+
<p align="center">
109+
<img src="https://raw.githubusercontent.com/bhavesh1129/orphan_support-php/main/assets/img/compare.png">
110+
</a>
111+
112+
* Now submit the pull request.
113+
114+
<p align="center">
115+
<img src="https://raw.githubusercontent.com/bhavesh1129/orphan_support-php/main/assets/img/pullrequest.png">
116+
</a>
117+
118+
* 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.
119+
<hr>
120+
121+
***: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.***
122+
123+
## Style Guides for Git Commit Messages:memo:
124+
125+
#### Here's a list of some good to have points, that can add more value to your contribution logs.
126+
127+
- Use the present tense (example: "Add feature" and not "Added feature")
128+
- Use the imperative mood (example: "Move item to...", instead of "Moves item to...")
129+
- Limit the first line (also called subject line) to 50 characters or less
130+
- Capitalize the subject line
131+
- Separate subject from body with a blank line
132+
- Do not end the subject line with a period
133+
- Wrap the body at 72 characters
134+
- Use the body to explain what, why, vs, and how
135+
- Reference issues and pull requests liberally after the first line
136+
137+
### So, What are you waiting for? Begin contributing now! :fire: :rocket:
138+
139+
#### All the Best!🥇

0 commit comments

Comments
 (0)