Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 4.34 KB

contributing.md

File metadata and controls

85 lines (56 loc) · 4.34 KB
Raw

Rails Girls Houston, October 2014 Guide

This guide is written with love from the Rails Girls Houston Team.

Goal & Tone

To provide a follow along guide that facilitates conversation with the coaches around app design areas and concepts. We are aiming to inspire with exposure to Rails, and also encourage more experienced students to explore with guidance.

Tone so far has been using first person (we, let's, etc...) as much as possible. Also, we trigger some errors on purpose to familarize students with dealing with errors and to show how helpful Rails can be about errors.

The app

is at this app repo, currently. Each section is being tagged at each step as much as possible.

The base app is a single model CRUD app called Chirper that is an imitation of Twitter. It is barebones, and does not, for example, use a CSS framework immediately.

Section 6/What else can we do is where all the fun stuff is (like making things easier on the eyes with Bootstrap).

Section 6 guides that need lots of love

are here.

To contribute,

if you are a coach, we'd like to add you to the Team and collaborators of this repo! Please email Amanda if you haven't been invited to the repo and would like to contribute =).

  • Clone & branch.
    • Fork if not yet a member.
  • Edit and preview your changes by using your favorite text-editor, or with the Gitbook editor.
  • Submit pull request with description of what was added. If there is a pre-formed issue about it, please tag the issue.
  • Update app accordingly.

Editing with your favorite text editor and npm/command-line

  • Run npm install within the project folder.
  • View the book as you edit by running:
    • npm run dev
      • If you need to change the port, or the live-reload port, you can pass in options like so:
      • npm run dev -- --lrport=35730 --port=4001
    • As you make changes, this preview will reload!
    • The script uses gitbook-cli underneath.
  • Things to note:
    • To edit things in the table of contents
    • Images should go in the ./images directory.

Editing in Gitbook editor

  • Download the Gitbook editor.
  • Open repo using Gitbook.
    • Edit it and see the markdown live preview =).

Other todos include

  • Complete (draft of) section 3.1 about messages #12
  • Complete (draft of) section 3.2 on showing messages by author #13
  • Upgrade app from Rails 4.2.0.beta2 to stable #7
  • Re-do screenshots all the way through cleanly #8
    • If there is time, redo app repo and tag it cleanly as well.
  • Test through guide, revise as needed #9
  • If Mac this, if PC that language in guide #10
    • Ideally, this would be something that toggles to show the selected one. It will be static if making it toggle will take up too much time.
  • Link discussions/concepts to reference pages/appendix with the intent of helping someone who looks at the book again after the workshop. #11
    • Appendix is last priority, and can be perfected after workshop if there is not enough time.

This guide is inspired by

Tips

To make a single window screenshot on a Mac,

  • press cmd + shift + 4,
  • press space, and finally
  • click on the window you'd like to capture.