Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write a more helpful README #78

Open
crawfoal opened this issue Aug 20, 2016 · 1 comment
Open

Write a more helpful README #78

crawfoal opened this issue Aug 20, 2016 · 1 comment

Comments

@crawfoal
Copy link
Owner

Give instructions on how to run through the demo, and only link to the production version (don't give staging link).

@crawfoal
Copy link
Owner Author

Include instructions for new developers, like:

  • links on how to set up their machine for rails development
  • how to setup their machine for development on this specific project, including how to run tests
  • link to a contributing doc
  • description review app / pull request workflow (maybe put this in the contributing doc instead):
    1. open pull request
    2. go to the project's heroku pipepline dashboard (can they actually access this?) and build the review app (should see option under review apps col)
    3. run the review app script: ./bin/review_app_setup (explain what that script does and why we don't just use the db:populate task)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant