diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0cd5903339..eef312f2a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -102,7 +102,7 @@ In the `hfla-site` Slack channel, send an introductory message with your GitHub Before cloning your forked repository to your local machine, you must have Git installed. You can find instructions for installing Git for your operating system [**here**](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). Please note that if you have a Mac the page offers several options (see other option, if you need to conserve hard drive space) including: - an “easiest” option (this version is fine for use at hackforla): This option would take just over 4GB. -- a “more up to date” option (not required but optional if you want it): This option prompts you to go to install an 8GB package manager called Homebrew. +- a “more up to date” option (not required but optional if you want it): This option prompts you to go to install an 8GB package manager called Homebrew. - Other option: If your computer is low on space, you can use this [tutorial](https://www.datacamp.com/community/tutorials/homebrew-install-use) to install XCode Command Tools and a lighter version of Homebrew and then install Git using this command: ```$ brew install git``` which in total only uses 300MB. [Back to Table of Contents](#table-of-contents) @@ -132,7 +132,7 @@ You can fork the hackforla/website repository by clicking [Back to Table of Contents](#table-of-contents) - + #### **2.7.d Working on an issue (4): Pulling from upstream before you push** **IMPORTANT:** Before you push your local commits to your repository, sync your fork to the main Hack For LA website repository. `git pull upstream` will ensure that your local repository is up-to-date with the main site: @@ -630,7 +629,7 @@ You can also sync your fork directly on GitHub by clicking "Sync Fork" at the ri If you do not see any output, there have not been any changes in the main Hack for LA website repository since the last time you checked. So it is safe to push your local commits to your fork. -If you just type `git push` you will be prompted to create a new branch in your GitHub repository. The more complete command below will create a new branch on your copy of the website repository, and then push your local branch there. The name at the end of this command should be the same as the name of the local branch that you created back in step 3, as in the example below: +If you just type `git push` you will be prompted to create a new branch in your GitHub repository. The more complete command below will create a new branch on your copy of the website repository, and then push your local branch there. The name at the end of this command should be the same as the name of the local branch that you created back in step 3, as in the example below: ```bash git push --set-upstream origin update-give-link-2093 @@ -666,26 +665,26 @@ One way to keep your fork up to date with this repository is to follow these ins You can also update your fork via the local clone of your fork, using these instructions. Assuming you have a local clone with remotes `upstream` (this repo) and `origin` (your GitHub fork of this repo): -* First, you will need to create a local branch which tracks upstream/gh-pages. You will only need to do this once; you do not need to do this every time you want to incorporate upstream changes. +* First, you will need to create a local branch which tracks upstream/gh-pages. You will only need to do this once; you do not need to do this every time you want to incorporate upstream changes. -Run the following two commands: +Run the following two commands: ```bash git fetch upstream git checkout -b upstream-gh-pages --track upstream/gh-pages ``` -If you have already created the branch upstream-gh-pages, the following commands will incorporate upstream changes: +If you have already created the branch upstream-gh-pages, the following commands will incorporate upstream changes: ```bash -git checkout upstream-gh-pages # Move to the branch you want to merge with. +git checkout upstream-gh-pages # Move to the branch you want to merge with. git pull # This updates your tracking branch to match the gh-pages branch in this repository git checkout gh-pages # Move back to your gh-pages branch -git merge upstream-gh-pages # Merge to bring your gh-pages current. +git merge upstream-gh-pages # Merge to bring your gh-pages current. ``` If you do all your work on topic branches (as suggested above) and keep gh-pages free of local modifications, this merge should apply cleanly. -Then push the merge changes to your GitHub fork: +Then push the merge changes to your GitHub fork: ```bash git push @@ -791,7 +790,7 @@ clip < ~/.ssh/id_ed25519.pub #### **3.1.a Push all changes to your issue branch** -Once you are satisfied with your changes, push them to the feature branch you made within your remote repository. +Once you are satisfied with your changes, push them to the feature branch you made within your remote repository. ```bash git push --set-upstream origin update-give-link-2093 @@ -808,7 +807,7 @@ git push --set-upstream origin update-give-link-2093
Click here to see pull request markdown template - + ``` Fixes #replace_this_text_with_the_issue_number @@ -835,7 +834,7 @@ git push --set-upstream origin update-give-link-2093
Visuals after changes are applied - + ![image](Paste_Your_Image_Link_Here_After_Attaching_Files)
@@ -851,13 +850,13 @@ git push --set-upstream origin update-give-link-2093 ##### **i. Complete pull request (1): Update pull request title** * When the pull request is opened, the title input box will be the where the cursor defaults to. -* The default title will be your last commit message from your branch. +* The default title will be your last commit message from your branch. * Please change it to provide a summary of what you did. * For our example (PR [Update Care Link in Credits Page - #2131](https://github.com/hackforla/website/pull/2131)), [@adrian-zaragoza](https://github.com/adrian-zaragoza) provided the following title: ``` Update Care Link in Credits Page - ``` + ``` **Advice:** Provide a 4-12 word summary of your resolution to the issue you are handling. @@ -911,7 +910,7 @@ in the gif example [near the top of this part within the gif of completing pull
Visuals after changes are applied - + ![image](https://user-images.githubusercontent.com/77212035/130176069-9c1cc306-f930-43a5-9f93-1249466c81dc.png)
@@ -938,7 +937,7 @@ After you have submitted your pull request, add it to the project board by click ##### **vi. After pull request is submitted/merged** -**NOTE**: After completing your assignment and committing all of the changes, you must leave your current branch and return to the `gh-pages` branch. +**NOTE**: After completing your assignment and committing all of the changes, you must leave your current branch and return to the `gh-pages` branch. Run the following command to return to the `gh-pages` branch: @@ -946,7 +945,7 @@ Run the following command to return to the `gh-pages` branch: git checkout `gh-pages` ``` Once your pull request is merged you can delete your branch with the following command: - + ```bash git branch -d update-give-link-2093 ``` @@ -992,7 +991,7 @@ The best way to ask for help and provide as much information to the team is to d
1. Write down your blocker as a comment within your issue - * Describe the blocker and your approach to resolve the action items within the issue. + * Describe the blocker and your approach to resolve the action items within the issue. 2. Note which branch you are working on and make sure it has the changes you are referring to.
@@ -1025,7 +1024,7 @@ The best way to ask for help and provide as much information to the team is to d * [GitHub Pages](https://pages.github.com/) * [Jekyll Docs](https://jekyllrb.com/docs/) * [Liquid Documentation](https://shopify.github.io/liquid/) -* [Github Guides](https://guides.github.com/) +* [Github Guides](https://guides.github.com/) * [Docker](https://docs.docker.com/get-started/) - [Docker Compose](https://docs.docker.com/compose/gettingstarted/) - [Docker Desktop](https://docs.docker.com/install/)