Skip to content

Latest commit

 

History

History
56 lines (43 loc) · 2.78 KB

submitting.md

File metadata and controls

56 lines (43 loc) · 2.78 KB
Raw

Submitting work to CodePath

  1. project README.md file
  • it's pretty easy to add a README file up on GitHub (there is a big green "Add a README" button on all projects without one)
  • once you click the "Add a README" button in your GitHub repo, then
  • paste the appropriate template into the "Edit new file" section:
  • make changes to take out the generic names & add your and your app's names
  • "Commit new file"
  • then Sync with the project as saved on your computer
  1. create animated GIF of your app:
  • download the latest version of LICEcap for OSX
  • install on your Mac
  • open LICEcap from your Applications folder
  • (you might select the "Keep in Dock" option)
  • adjust the "frame" of the LICEcap so it surrounds your Simulator demonstrating your app
  • press RECORD
  • save .GIF filename
  • wait until the word "PREROLL" disappears
  • then start interacting with your app
  • press STOP to end the recording
  1. add animated GIF to project README.md file:

  • save the new .GIF in the same folder as your README.md

  • edit the README.md (pretty easy to do up on GitHub by clicking on the README.md file & then clicking the pencil icon to edit)

  • add the following text to your README.md in between the text where you would like to see the animated GIF

    ![Walkthrough](tips.gif)

    • you don't have to use "Walkthrough" -- you could use any text. And "tip.gif" is just the name of your animated GIF.

  • write a Commit message like 'add animated GIF to README.md' and click the green "Commit changes" button

  • then Sync with the project as saved on your computer

  1. checking off completed features in README.md checklist

  • you'll notice that, at the beginning of each item in the lists of features to implement, you'll see:

    * [ ]

    • this creates an unchecked checkbox.

  • If later, you edited to this:

    * [x]

    • this will create a checked checkbox, indicating that you've implemented that feature.
  1. creating an Issue to notify CodePath that you're all done
  • in GitHub, you'll need to raise an "Issue" and tag CodePath on it.
  • this will send CodePath reviewers a notification to come examine your submission
  • open your repo on GitHub.com, and use the Issues feature to publish a new issue. On the issue, write comments similar to the following screenshot:
  • Sample issue raised in GitHub
  • make sure your comments end with this exact text: /cc @codepathreview. This code is what tells GitHub to send a notification to the @codepathreview account.
  1. complete this survey: https://www.surveymonkey.com/r/BHLPQW3
  • this allows CodePath to connect your GitHub account to your signup including which school you belong to

Return to the main page.