From 4c14383ce7d6498deb8ed63f6cb5ec2a1a2d791b Mon Sep 17 00:00:00 2001 From: Otavie Date: Mon, 5 Jun 2023 10:56:21 +0100 Subject: [PATCH 1/2] Add Steps to First Time Contribution to OS Project --- .../Steps-to-First-Contribution.md | 84 +++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 guides/Version_Control/Steps-to-First-Contribution.md diff --git a/guides/Version_Control/Steps-to-First-Contribution.md b/guides/Version_Control/Steps-to-First-Contribution.md new file mode 100644 index 00000000..884267e8 --- /dev/null +++ b/guides/Version_Control/Steps-to-First-Contribution.md @@ -0,0 +1,84 @@ +

+Getting Started with Open Source Contributions on GitHub +

+ +### Note: +**_repo = repository_** + +### Step 1. Locate the Repo Where You Want to Contribute +Go to the repo where you want to contribute. For example, let's use the repo "the-ethan-hunt/first-timers-guide". + +### Step2: Fork the Repo +Fork the repo by clicking on the "Fork" button located at the top right-hand corner of the repo page. +- Forking creates a copy of the original repo in your GitHub account, allowing you to make changes without affecting the original repo. + +### Step 3. Open Your Terminal (e.g., Git Bash). + +- A). If you already have a directory where you want to work from: + - i. Navigate to that directory using the `cd` command. + - ii. Run `git init` to initialize the directory as a Git repo. + +- B). If you don't have a directory yet: + - i. Create a new directory using the `mkdir directory-name` command. + - ii. Navigate to the newly created directory using `cd directory-name`. + - iii. Run `git init` to initialize the directory as a Git repo. + +### Step 4. Clone Forked Repo +Clone the forked GitHub repo to your local machine using the `git clone ` command. For example: + ``` + git clone https://github.com/YourGitHubUsername/first-timers-guide.git + ``` + +### Step 5. Navigate to the Cloned Repo +Navigate to into the cloned repo directory by using the `cd` command. For example: + ``` + cd first-timers-guide + ``` + +### Step 6. Create Your Own Branch +Create a new branch for your changes using the `git branch ` command. Replace `` with a descriptive name for your branch. For example: + ``` + git branch + ``` + +### Step 7. Switch to New Branch +Switch to the newly created branch using the `git checkout` command. For example: + ``` + git checkout + ``` + +### Step 8. Make Your Changes, Additions or Modifications +Now you're ready to make your changes! Modify or add the necessary files in your code editor. + +### Step 9. Stage Your Changes +Once you've made the desired changes, you need to stage them. Run the following commands: + ``` + git add . + ``` + +### Step 10. Commit Your Changes +Once you've staged your changes, you need to commit them. Run the following commands: + ``` + git commit -m "Description of your changes" + ``` + +### Step 11. Push Your Branch +Push your branch to your forked repo on GitHub using the `git push` command. For example: + ``` + git push origin + ``` + +### Step 12. Create a PR (Pull Request) +Go to your forked repo on GitHub and you will see a prompt to create a pull request (PR) based on the branch you just pushed. Click on the **_"Compare & pull request"_** button. + +### Step 13. Follow the Requirements for a PR +Fill in the necessary details for your pull request, including a descriptive title and a clear description of your changes. + +### Step 14. Submission of PR +Submit the pull request, and wait for the repo maintainers to review your changes. They may provide feedback or request additional modifications before merging your changes into the main repo. + +### Note: Changes/Adjustment After Feedback +If there is need for modifications or changes to be made, make the necessary changes and start from step 11 again. + +### Congratulations 🎉 +Congratulations! You have made your first contribution to an open-source project on GitHub. Remember to stay engaged in the conversation around your pull request and be open to feedback from the maintainers and community. \ No newline at end of file From 60707e1c200b57ab7f7a894cffc8834591ea7dba Mon Sep 17 00:00:00 2001 From: Otavie Date: Mon, 5 Jun 2023 12:08:01 +0100 Subject: [PATCH 2/2] Modified the file length --- .../Steps-to-First-Contribution.md | 82 ++++++------------- 1 file changed, 26 insertions(+), 56 deletions(-) diff --git a/guides/Version_Control/Steps-to-First-Contribution.md b/guides/Version_Control/Steps-to-First-Contribution.md index 884267e8..56db1004 100644 --- a/guides/Version_Control/Steps-to-First-Contribution.md +++ b/guides/Version_Control/Steps-to-First-Contribution.md @@ -1,84 +1,54 @@ -

-Getting Started with Open Source Contributions on GitHub -

+# Getting Started with Open Source Contributions on GitHub -### Note: -**_repo = repository_** +### 1. Locate the Repository for Contribution +For example, "the-ethan-hunt/first-timers-guide" -### Step 1. Locate the Repo Where You Want to Contribute -Go to the repo where you want to contribute. For example, let's use the repo "the-ethan-hunt/first-timers-guide". +### 2: Fork the Repository +Click "Fork" button -### Step2: Fork the Repo -Fork the repo by clicking on the "Fork" button located at the top right-hand corner of the repo page. -- Forking creates a copy of the original repo in your GitHub account, allowing you to make changes without affecting the original repo. +### 3. Open Your Terminal +- Create a directory where you want to work from +- Navigate to the directory +- Run `git init` -### Step 3. Open Your Terminal (e.g., Git Bash). - -- A). If you already have a directory where you want to work from: - - i. Navigate to that directory using the `cd` command. - - ii. Run `git init` to initialize the directory as a Git repo. - -- B). If you don't have a directory yet: - - i. Create a new directory using the `mkdir directory-name` command. - - ii. Navigate to the newly created directory using `cd directory-name`. - - iii. Run `git init` to initialize the directory as a Git repo. - -### Step 4. Clone Forked Repo -Clone the forked GitHub repo to your local machine using the `git clone ` command. For example: +### 4. Clone Forked Repository +Clone the forked repository using `git clone `. For example: ``` git clone https://github.com/YourGitHubUsername/first-timers-guide.git ``` -### Step 5. Navigate to the Cloned Repo -Navigate to into the cloned repo directory by using the `cd` command. For example: +### 5. Navigate to the Cloned Repository +For example: ``` cd first-timers-guide ``` -### Step 6. Create Your Own Branch -Create a new branch for your changes using the `git branch ` command. Replace `` with a descriptive name for your branch. For example: +### 6. Create and Switch Branch ``` - git branch + git branch ``` - -### Step 7. Switch to New Branch -Switch to the newly created branch using the `git checkout` command. For example: ``` - git checkout + git checkout ``` +`` = descriptive name for your branch. -### Step 8. Make Your Changes, Additions or Modifications -Now you're ready to make your changes! Modify or add the necessary files in your code editor. +### 7. Make Your Changes, Additions or Modifications -### Step 9. Stage Your Changes -Once you've made the desired changes, you need to stage them. Run the following commands: +### 8. Stage and Commit ``` git add . ``` - -### Step 10. Commit Your Changes -Once you've staged your changes, you need to commit them. Run the following commands: ``` - git commit -m "Description of your changes" + git commit -m "Commit Message" ``` -### Step 11. Push Your Branch -Push your branch to your forked repo on GitHub using the `git push` command. For example: +### 9. Push Your Branch to the Forked Repository ``` - git push origin + git push origin ``` -### Step 12. Create a PR (Pull Request) -Go to your forked repo on GitHub and you will see a prompt to create a pull request (PR) based on the branch you just pushed. Click on the **_"Compare & pull request"_** button. - -### Step 13. Follow the Requirements for a PR -Fill in the necessary details for your pull request, including a descriptive title and a clear description of your changes. - -### Step 14. Submission of PR -Submit the pull request, and wait for the repo maintainers to review your changes. They may provide feedback or request additional modifications before merging your changes into the main repo. - -### Note: Changes/Adjustment After Feedback -If there is need for modifications or changes to be made, make the necessary changes and start from step 11 again. +### 10. Create PR (Pull Request) +Go to your forked repository on GitHub. Click the **_"Compare & pull request"_** button. -### Congratulations 🎉 -Congratulations! You have made your first contribution to an open-source project on GitHub. Remember to stay engaged in the conversation around your pull request and be open to feedback from the maintainers and community. \ No newline at end of file +### 11. Submit PR +And wait for feedback from repository maintainer. \ No newline at end of file