Welcome to Tweechable Moments! This is a guide for new members who want to contribute to the project's technical portion. We require that new members read our Code of Conduct before getting started.
- Git Version 2.10.1
- Ruby Version 2.3.1
- Rails Version 5.0.0.1
- Postgres 9.5.4
- Bundler gem
We highly recommend using homebrew to install needed components. Here are further instructions.
Check if you have already installed Homebrew. If you have installed Homebrew, you should see the below.
$ which brew /usr/local/bin/brew
If you don't see that, run the below to install homebrew
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
See if you have git installed
which git /usr/local/bin/git
If you don't get a result, run the below to install git.
brew install git
We highly recommend you use a Ruby manager, preferably rbenv, to manage your Ruby version.
First, check if you already have rbenv installed.
which rbenv /usr/local/bin/rbenv
If you don't get a result for which rbenv, run the below
$ brew install ruby-build rbenv
After installing rbenv, add the below to your .bash_profile to tell your computer to use rbenv
if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi
Use rbenv to see all of the rubies available for install
$ rbenv install --list
Will show you all the rubies available for installation
$ rbenv install 2.3.1
Will install ruby version 2.3.1
$ rbenv global 2.3.1
Will set the global ruby. (The global ruby will be used by default in all your work on your local machine.)
gem install bundler
- A few requirements:
- You have Ruby on Rails (
railsandruby, possibly through RVM or rbenv) on your machine - You have
giton your machine - You have PSQL (
postgresql) on your machine - You have the
bundlergem on your machine
- You have Ruby on Rails (
git clonethe repository to your local machine (see here for help)- Setup your authentication token (see below)
- In terminal:
- Start postgres locally (usually using
psqlcommand, orsudo su - postgres)- If you don't have postgres,
$brew install postgresql - Start the postgres server:
$pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start - To eventually stop the server:
$pg_ctl -D /usr/local/var/postgres stop -s -m fast
- If you don't have postgres,
- Create a DB in postgres called tweechable_development
cdinto the cloned directorybundle install- install all of the needed gems (specified in the Gemfile)rake db:migrate- updated your local database schema to the latest point based on the migrations (note that postgres must be running for this to work)rake db:seed- fill the database with seed data (note that postgres must be running for this to work)rails server- hosts local server atlocalhost:3000
- Start postgres locally (usually using
- Prerequisites: Register a Twitter account with a phone number. Twitter requires having a phone number for obtaining the authentication tokens
- Follow the instructions to create a new Twitter app on the Twitter Apps Panel
- Go to "Keys and Access Tokens" tab. You should have your consumer key and consumer secret key.
- Scroll down and click "create my access token".
- Replace the content in quotes with your own tokens in the
app/models/twitter_api.rbfile and you are done 😃
- See something in Tweechable that could be better? Open an issue!
- If you want to work an an existing issue, please assign yourself to it and/or comment on it that you are working on it.
- If someone is already working on an issue that interests you, contact them about collaborating.
- Once you start working on an issue, create a branch on your local machine that starts with the issue number and then summarizes the task (e.g.
95/fix-sign-up-form) - This is Chicago: when working, commit early, commit often.
- After you finish up your work, push your branch to the tweechable_final repo and open a pull request.
- Do not merge your own pull request!
- One technical project maintainer needs to approve and merge your pull request
- Technical Project Maintainers as of February 2018 are: @McEileen, @vkoves, @javierforero
- In order to become a technical project maintainer, you should make four (or more) contributions to Tweechable's tech component over a month. Involvement includes, but is not limited to:
- Attending a monthly meeting
- Opening issues
- Making pull requests
- Offering feedback on code
- Offering feedback on documentation
- Only technical project maintainers will make pushes to the twitter bot itself.
- Only technical project maintainers can make pushes to master
- Before making a push to production in heroku, you must push to tweechable-staging to ensure changes will not break production
- If someone is invited to be a contributor for to the tweechable repo, then doesn't contribute to the project for a month, they will be removed as a contributor.
- Write clear, concise commit messages.
- For inspiration on how to write good commit messages, please watch this video Do Your Commit Messages Suck: by Ryan McGeary. We learned of the video through exercism - thanks, exercism!
- Write tests.
- Tweechable tracks test coverage with the Travis CI and simplecov gems. To run simplecov, type
rake testin terminal and open the generated html file to view test coverage.
If you are new to Tweechable's tech stack and would like more experience, check out the resources below.