diff --git a/README.md b/README.md index 1e5d044..6bc1155 100644 --- a/README.md +++ b/README.md @@ -18,4 +18,137 @@ 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. + + + +### [Prerequisities](./knowing%20the%20steps.md) +Prerequisites for Starting with Open Source are +Essential things to know before contributing. + + +### What is Git? +Git is a distributed version control system used to track changes in files, especially source code, enabling efficient collaboration among multiple developers. + + + +To knonw more explore https://git-scm.com/ + + +### How to Install Git +Choose your operating system: + +For Windows +Visit the official Git website: https://git-scm.com/download/win + +Download the Git installer for Windows. + +Run the installer and follow the setup wizard with default recommended settings. + +After installation, open Command Prompt or Git Bash and verify by running: + + +git --version +### For macOS +The easiest method is using Homebrew. Open Terminal and run: + + +brew install git +Alternatively, download the Git installer from https://git-scm.com and install it. + +Verify installation by running: + + +git --version + +Configure Git (All Operating Systems) +After installing Git, set your name and email to identify your commits: + + +git config --global user.name "Your Name" +git config --global user.email "your.email@example.com" +### After Installing Git Next Steps : +Congrats! You've completed 50% of your journey to your first open source contribution. + +To continue: + +Create a GitHub profile if you don't have one: https://github.com/join + +Choose a repository you want to contribute to and open it on GitHub. + +Click the Fork button on the top-right to create your own copy of the repo. + +Click the green Code button, copy the HTTPS URL. + +Open your terminal or command prompt and clone your fork using: + + +git clone +Navigate inside the cloned repository folder to start making changes. + +### Example Workflow for Your First Pull Request +Fork the Repository +Go to the repository on GitHub and click "Fork" to create a copy under your account. + +Clone Your Fork Locally + + +git clone https://github.com/your-username/repository-name.git +cd repository-name +Create a New Branch +Keep your work organized by branching off from the main branch: + + +git checkout -b feature-branch-name +Make Your Changes and Commit +Edit files locally and then: + + +git add . +git commit -m "Clear, concise message describing what you changed" +Push Your Branch to GitHub + + +git push origin feature-branch-name +Create a Pull Request on GitHub +Visit your forked repo on GitHub; you’ll see a prompt to open a pull request for your pushed branch. +Click Compare & pull request, add a description explaining your changes, and submit. + +Respond to Feedback +If maintainers request changes, make updates locally, commit again, and push. Your PR updates automatically. + +Celebrate Your Contribution! +Once reviewed and approved, your changes will be merged into the main project. You’ve made a positive impact! + +T + + + + + + + + + +### Example Workflow for First Pull Request +Fork the Repository +On GitHub, navigate to the repository you want to contribute to and click the "Fork" button to create your own copy of the repo. + +Clone Your Fork Locally +In your terminal, run: +git clone https://github.com/your-username/repository-name.git +cd repository-name + + +Create a branch for your changes to keep your work separate from the main branch: +git checkout -b feature-branch-name + + +Edit files locally. After changes: +git add . +git commit -m "A clear message describing your changes" + + +git push origin feature-branch-name + + +On GitHub, go to your forked repository. A prompt usually appears to create a pull request for your pushed branch. Click "Compare & pull request". Add a description explaining your changes and submit the PR diff --git a/knowing the steps.md b/knowing the steps.md new file mode 100644 index 0000000..59c9fea --- /dev/null +++ b/knowing the steps.md @@ -0,0 +1,20 @@ +1. Programming Knowledge + +Know at least one programming language well (Python, JavaScript, C++, etc.) so you can actually read and write code in a project. + +Be comfortable with basic debugging and reading other people’s code — because most contributions involve understanding existing code first. + + +2. Version Control (Git & GitHub/GitLab) + +You must know how to use Git, since almost all open source projects use it. + +3. Non-Code Contributions Count Too + +You don’t always need to write complex code. You can start by: + +Fixing typos / grammar in docs. + +Improving README.md or documentation. + +Writing tests. \ No newline at end of file