Skip to content
This repository was archived by the owner on Apr 14, 2025. It is now read-only.

General Instructions

Roy Mosby edited this page Feb 9, 2023 · 2 revisions

Assignment Repo Setup

Note: Setup is also covered in lesson 1.1

  1. In GitHub, create your own repository in GitHub with the name react-todo
  2. Click the "Code" button and copy the URL for your repository
  3. In your local development environment, open up your terminal in the location where you want your project to reside.
  4. Clone this repository so that the code is available on your local machine:
git clone <url>

Note: replace <url> with the URL you copied in the previous step

  1. Navigate to the directory you just cloned in your terminal with the following command:
cd react-todo

Before each Lesson

  1. On GitHub, merge your pull request on from the previous lesson into main.

View tutorial on how to merge

  1. In your local development environment, checkout your main branch and pull changes:
git checkout main
git pull
  1. Create a new branch for the lesson:
git checkout -b <branch>

Note: Replace <branch> with your new branch name (ex. lesson-1-1)

  1. Open the project directory in your code editor and begin the lesson.

After each Lesson

  1. Make sure application works in browser before submission.
  2. Perform code cleanup:
  • remove any private comments, commented-out code
  • ensure formatting (indentation, spaces around brackets, etc.) is consistent
  1. Check the status of your local repository to double-check the changes you made:
git status
  1. Stage the file(s) that you edited:
git add .
  1. Check the status again and notice that the changes from before are now staged:
git status
  1. Create a commit for the changes you made and add a message describing the changes you made:

Note: Replace <message> with your message

git commit -m "<message>"
  1. Push your commit to the remote repository (visible in GitHub):
git push
  1. Check the log to make sure your commit has been published:
git log --oneline
  1. Go to the repo in GitHub and create a pull request.

  2. Copy the link of the pull request in the browser's URL bar and keep handy for assignment submission. The structure of the link should resemble:

                  |username      |repo name          |contains "pull" in URL
https://github.com/starstudent123/ctd-react-albatross/pull/18

Note: PRs increment so the number does not represent the lesson number. The example above is the 18th PR opened on that repo.

Visual instructions to create PR

Common Mistakes

A common occurrence is that students open PRs on original class repo:

INCORRECT: wrong repo

                  |should not contain CTD GitHub org name
https://github.com/Code-the-Dream-School/ctd-react-albatross/pull/51

Another common mistake is submitting links that are not to a PR:

INCORRECT: wrong types of links; not PRs

https://github.com/starstudent123/ctd-react-albatross 
https://github.com/starstudent123/ctd-react-albatross/tree/main/src
https://github.com/starstudent123/ctd-react-albatross/blob/main/src/App.js

Clone this wiki locally