Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

84 lines (63 loc) · 1.82 KB

How to Contribute

Getting Started

  1. If you don't already have a GitHub account, head over to their website to create one.
  2. Create a fork and clone a copy

If you're new to Git, here's some resources to help you:

Add a new episode

  1. Go to your project directory

    cd /path/to/joy-of-coding-episode-guide
    
  2. Update your master branch

    git pull upstream master
    
  3. Create a new branch (e.g add-episode-1234)

    git checkout -b add-episode-1234
    
  4. Create a new folder in the _episodes folder. The name of your folder should be composed of 4 digits (e.g 1234 for the episode 1234).

  5. Create an index.md file inside your newly created folder.

  6. Copy and paste the following template inside the index.md file.

    ---
    layout: default
    date: YYYY-MM-DD
    number: 1234
    ---
    
    ## Episode 1234: MMM DD, YYYY
    
    ### Links
    
    ### Topics
    
    ### Other
    
  7. Edit your index.md as needed. You can look other episodes' files to see an example.

  8. Save your changes to your fork

    git add 1234
    git commit -m "add episode 1234
    git push origin add-episode-1234
    
  9. Open a Pull Request and wait for Mike to merge it.

Run a copy of the website locally

  1. Install Jekyll

  2. Go to your project directory

    cd /path/to/joy-of-coding-episode-guide
    
  3. Install the dependencies

    bundle install --path vendor/bundle
    
  4. Run Jekyll

    bundle exec jekyll serve