https://github.com/foss-cell-gecpkd/hello-opensource
This is your "Hello world" for open source contributions. Want to try practicing some PRs? This the right place!
https://github.com/foss-cell-gecpkd/hello-opensource
git open-source
Last synced: 8 months ago
JSON representation
This is your "Hello world" for open source contributions. Want to try practicing some PRs? This the right place!
- Host: GitHub
- URL: https://github.com/foss-cell-gecpkd/hello-opensource
- Owner: FOSS-Cell-GECPKD
- Created: 2020-09-08T16:57:15.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-21T11:36:06.000Z (almost 3 years ago)
- Last Synced: 2023-06-15T18:28:47.284Z (over 2 years ago)
- Topics: git, open-source
- Homepage:
- Size: 32.2 KB
- Stars: 7
- Watchers: 2
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hello Opensource
This is your "Hello world" for open source contributions. Want to try practising some PRs? This is the right place!
## Step 1: Fork this repo
This creates a copy of this repo to your GitHub account. Consider a scenario where you want to work with some code from your friend. So you copy the code in a flash drive from your friends PC. Forking is similar to this.
## Step 2: Clone the repo
Now, go to the fork of this repo **on your account**. To work with code, clone that repo to your local machine (as shown below). Similar to copying the code from the flash drive to your system. If you haven't installed the git, then this is the best time to do this - [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) is a guide on installing git
Click on "Code"
Copy the link
To clone the repo, open the terminal and run the command
```
git clone "url-you-copied"
```
Now you have the project repo on your local machine.
## Step 3: Create a new branch
Go to the repo directory on your machine
```
cd Hello-opensource
```
Create a new branch (It is a good practice to create a new branch if you wish to contribute)
```
git checkout -b
```
for example:
```
git checkout -b add-bruce-wayne
```
Why create a new branch?
You don't want to mess the code your friend has already written. By creating a new branch, you can safely work on top of the friend's progress.
## Step 4: Create a new file
Go to contributions folder
```
cd contributors
```
Create a new file in that directory and fill in your info.
For example:
```
Name: Bruce Wayne
Github: [batman](https://github.com/batman)
```
Save as `.md`
## Step 5: Commit changes
If you finalise the changes you can store the changes permanently by two steps
- `add` the changes
```
git add
```
- `commit` the changes
```
git commit -m "Add to contributors"
```
## Step 6: Push changes
Push the changes to your repo by:
```
git push origin
```
From our example, we had already copied the files from the flash drive. We made some changes. Now we are copying back the changed file to flash drive so that we can give our changes to the friend.
## Step 7: Create a pull request
Here you're giving the flash drive to your friend. So he/she can look into the changes you have made. If everything is good, he/she can have the changes you made to his/her project.
First, go to the GitHub repo in your account. Click `Compare & pull request`
And submit the pull request by clicking `Create pull request`
## Hurray!
Congratulations, you have made it. Got any doubts? Feel free to let us know at our Discord!
## Summary
fork ----> clone ----> make changes -- +
|
create a PR <---- push <---- commit <-- +
## Addditional resources
Check out this [link](https://openhack.gitbook.io/openhack-20/resources#git-and-github) if you would like to explore more!
This project was a part of FOSS OpenHack '20: https://openhack.gitbook.io/openhack-20/.