diff --git a/README.md b/README.md index 1e5d044..1a223dd 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,55 @@ An Open Source sprint is a short event where groups of people get together to wo ### [Meet the Contributors](./open_source_stories.md) About the contributors to this repo and their Open Source experience. + +*** + +## 🚀 Getting Started & Your First Contribution + +Welcome! If you are joining us through events like Hacktoberfest, GSoC, or NumFOCUS, this guide will help you quickly set up your local workspace environment and successfully submit your very first open-source Pull Request (PR) to this repository. + +### 1. Install Git +Before contributing, you need Git source control installed on your system: +* **Official Download**: Visit the [Official Git Downloads Page](https://git-scm.com) and download the appropriate package installer for Windows, macOS, or Linux. +* **Ubuntu / WSL2 Users**: Open your Linux command terminal pane and run the following command directly: + ```bash + sudo apt update && sudo apt install git -y + ``` + +### 2. Fork and Clone the Repository +Instead of making changes directly to this main project layout, you will safely develop updates on your own cloud copy (called a "fork"): +1. Scroll to the top-right corner of this GitHub screen and click the **Fork** button. +2. Once the fork repository layout is generated under your personal GitHub profile account, copy its project URL path. +3. Open your terminal screen and execute a clone command to download the text files to your computer machine (remember to replace `YOUR_USERNAME` with your actual personal GitHub username structure): + ```bash + git clone https://github.com + cd open-source-barriers + ``` + +### 3. Make Your First Pull Request (PR) +Follow these standard industry development steps to safely capture your workspace adjustments: + +* **Step 3.1: Create a safe workspace branch** + Never save structural edits directly onto your local `main` branch. Spin up a separate, isolated testing sandbox workspace branch layout: + ```bash + git checkout -b my-first-contribution + ``` + +* **Step 3.2: Save your file edits** + Open the repository documentation folder pages inside your preferred code studio editor workspace (such as VS Code), adjust the text files, and hit save. + +* **Step 3.3: Stage and commit your changes** + Run these targeted index tracking flags to declare exactly which file updates you want to snapshot log into Git history: + ```bash + git add . + git commit -m "docs: add clear Git setup and beginner contribution steps to README" + ``` + +* **Step 3.4: Push code up to GitHub** + Upload your sandbox tracking branch line directly up to your personal upstream GitHub storage account fork: + ```bash + git push origin my-first-contribution + ``` + +* **Step 3.5: Submit the PR** + Go back to your personal fork page on the GitHub website. You will see a yellow banner appear at the top. Click **"Compare & pull request"**, fill out a short summary of what you did, and click the green **"Create pull request"** button! \ No newline at end of file