diff --git a/README.md b/README.md index 1e5d044..b5b2896 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,34 @@ 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. + +### **1. Installing Git** + +First, you'll need **Git**, the version control system we use to manage the project. + +* **Windows:** [Download Git for Windows](https://git-scm.com/download/win). +* **macOS:** Install with Homebrew by running `brew install git`. +* **Linux (Debian/Ubuntu):** Run `sudo apt-get install git`. + +You can verify your installation by running `git --version` in your terminal. + +--- + +### **2. Forking and Cloning the Repository** + +To work on the project, you need your own copy of it. + +1. **Fork the Repository:** On our GitHub page, click the **"Fork"** button in the top-right corner. +2. **Clone Your Fork:** In your terminal, run `git clone https://github.com/YOUR-USERNAME/repository-name.git`. +3. **Add the Upstream Remote:** Navigate into your project folder and run `git remote add upstream https://github.com/ORIGINAL-OWNER/repository-name.git`. This helps you keep your fork in sync with the main project. + +--- + +### **3. Your First Pull Request** + +Ready to make your first change? Follow this simple workflow. + +1. **Create a New Branch:** Run `git checkout -b new-feature-branch` to create a new branch for your changes. +2. **Make and Commit Changes:** After your edits, stage your files with `git add .` and then commit them with a descriptive message like `git commit -m "docs: adds a guide for new contributors"`. +3. **Push to Your Fork:** Push your new branch to your forked repository on GitHub with `git push origin new-feature-branch`. +4. **Open a Pull Request:** Go to your fork on GitHub. You should see a banner at the top prompting you to **"Compare & pull request"**. Click on it to submit your changes for review.