benny-fields3rd / firstContributions

This repo allows Open Source beginners to learn how to contribute to Open Source Projects on Github!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

firstContributions

This repo allows Open Source beginners to learn how to contribute to Open Source Projects on Github!

Inspired by https://github.com/firstcontributions/first-contributions, this repo provides a smaller version of this project for the Red Hat BUILD event.

Follow these steps to create your first contribution!

PREREQUISITES

Git, a Github account, and a Text Editor are required to complete this contribution, and is also a standard toolkit for contributing to most open source projects.

Resources

Git Cheat Sheet: https://education.github.com/git-cheat-sheet-education.pdf

STEP 1: Fork the Repository (this creates a personal copy of this project in your Github account)

At the top right corner of this github repository, click the "Fork" button.

Screenshot from 2020-10-01 10-14-33

STEP 2: Clone the Forked Repository (this copies the project to your local machine)

Go to the repository you just forked and clone it

git clone <forked-repo-url>

Screenshot from 2020-10-01 10-21-52

STEP 3: Go into the repository folder on your machine

Change to the repository directory on your computer (if you are not already there):

cd <forked-repo>

Screenshot from 2020-09-30 11-58-40

STEP 4: Create a branch

Create a branch using the git checkout command:

git checkout -b <your-new-branch-name>

Screenshot from 2020-09-30 12-07-15

STEP 5: Add your name to Contributors.md and commit those changes

Now open Contributors.md file in a text editor, add your name and College/University to it, in the format

[Jane Doe] [College/University]

Screenshot from 2020-09-30 12-14-00

STEP 6: Commit your changes

git status

Screenshot from 2020-09-30 12-20-27

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

git add Contributors.md

OR

git add .

Screenshot from 2020-09-30 12-20-38

Now commit those changes using the git commit command:

git commit -m "Add <your-name> to Contributors list"

Screenshot from 2020-09-30 12-20-47

STEP 7: Push your changes to your forked repository

git push origin <name-of-branch>

Screenshot from 2020-09-30 12-25-32

STEP 8: Submit your changes for review with a Pull Request

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

Screenshot from 2020-10-01 10-35-43

Screenshot from 2020-09-30 12-29-09

NEXT STEPS: Contribute to more Projects!

Here are some other beginner friendly GitHub Projects:

  1. https://github.com/twilio-labs/open-pixel-art
  2. https://goodfirstissues.com/
  3. https://firstcontributions.github.io/

About

This repo allows Open Source beginners to learn how to contribute to Open Source Projects on Github!

License:MIT License