Skip to content

Getting Started

Alanna Risse edited this page Aug 23, 2018 · 7 revisions

This is the Getting Started Doc for how to contribute to this project.

All code submissions should be submitted via pull requests. Please read gitHubs docs on how to create a pull request.

Check out the repos:

Go find an issue to work on. be sure to assign it to yourself

Install the app and make your first contribution!

  1. In a terminal window, find/create a good directory to add the AppyHour project.
  2. git clone the repos and look in the readme.md doc for instructions on how to install.

git clone https://github.com/Thinkful-PDX-Dev/AppyHour-client.git . will clone the client repo to the current directory you are in.

git clone https://github.com/Thinkful-PDX-Dev/AppyHour-api.git . will clone the api repo to the current directory you are in.

  1. make sure you have the latest and greatest from master by doing a git pull while in the master branch
  2. make a new branch > '`git checkout -b yourinitials-issuenumber`` (or whatever branch name makes the most sense if no issue exists(.
  3. Make your changes.
  4. commit your changes. In a terminal window, go to the project repo folder.
  • git add .
  • then git commit -m 'your commit message'
  • then git push -u origin yourbranchname ( you ony have to do the -u origin part the first time)
  1. Go to the AppyHour gitHub repo you just pushed to on gitHub.com
  2. Find your branch under the branches and click "New Pull Request"
  3. Add a note, add leads for the roject (or alannarisse if you're not sure)
  4. Sit back and wait for your pull request to be reviewed.

If you are a Portland Thinkful student, alumni, or mentor and would like to contribute, please contact alanna risse on the thinkful slack channel.

Clone this wiki locally