/javascript-workbook

https://austincodingacademy.github.io/javascript-workbook

Primary LanguageJavaScript

CircleCI

Javascript Workbook

Claiming your workbook

  1. Click the 'Fork' button (choose your account if prompted).
  2. If you haven't set up your SSH keys yet, follow these helpful instructions
  3. Copy the SSH clone URL (don't use the default HTTPS URL) from your forked repository
  4. In your terminal (or in git bash, for Windows people), navigate (using cd) into a directory where you want to start keeping your repositories.
  5. Clone your new repository by typing git clone <forked clone URL> (the SSH URL you copied above) Forking a repository
  6. Now go into the new directory by using cd javascript-workbook
  7. Add the base repository as an upstream git remote add upstream git@github.com:AustinCodingAcademy/javascript-workbook.git
  8. Check the configuration of your remotes with git remote -v, it should look very similar to this (except it'll be YOUR username, not tjefferson08)
19:04 $ git remote -v
origin  git@github.com:tjefferson08/javascript-workbook.git (fetch)
origin  git@github.com:tjefferson08/javascript-workbook.git (push)
upstream    git@github.com:AustinCodingAcademy/javascript-workbook.git (fetch)
upstream    git@github.com:AustinCodingAcademy/javascript-workbook.git (push)

Push to Github and create a PR

  1. From your project directory, run npm install to tell NPM to install all the node modules we use in this class
  2. Use Atom (or another editor) to make the change to the JS function indicated in test/00LessonZeroTest.js
  3. Make sure the tests pass: run npm test test/00LessonZeroTest.js (look in the output for "1 passing")
  4. When you're finished, commit your changes and push to GitHub using the following commands:
git status
git add test/00LessonZeroTest.js
git commit -m "Lesson Zero Tests passing"
git push origin gh-pages
  1. Now go to your forked repository on GitHub (at https://github.com/your-username/javascript-workbook). A little yellow box should have popped up asking you to make a Pull Request. Click to review.

  2. Click "Create Pull Request"

  3. Every time you make a change and push to GitHub, this PR will automatically update. No need to do it more than once.

Get latest test updates

  1. To get the latest code/homework/test updates, be sure to have a "clean working directory" by committing or removing all of your changes. You check for a "clean working environment" by running git status and making sure no files show up.
  2. Run git pull upstream gh-pages

Contributing workflow

Running Tests

Tests are a great way to make sure you code works the way you planned it would, and to make sure you don't break something in the future. We will be using them to test our understanding of the lesson. It's also our main way to assign grades for an assignment.

Run a single test

To run a single test on an app, test, or a kata, simply run npm test apps/01PigLatin.js, etc. If you've installed mocha globally (npm install -g mocha), you could run mocha directly, e.g. mocha homework/01LessonOne.js