Skip to content

Commit

Permalink
Update README and pull_request_template
Browse files Browse the repository at this point in the history
  • Loading branch information
marshallwj committed Apr 1, 2022
1 parent 2ab76b6 commit 215c139
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
16 changes: 8 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Your name

Please write your full name here to make it easier to find your pull request.
William Marshall

# User stories

Please list which user stories you've implemented (delete the ones that don't apply).

- [ ] User story 1: "I want to see all the messages (peeps) in a browser"
- [ ] User story 2: "I want to post a message (peep) to chitter"
- [ ] User story 3: "I want to see the date the message was posted"
- [ ] User story 4: "I want to see a list of peeps in reverse chronological order"
- [x] User story 1: "I want to see all the messages (peeps) in a browser"
- [x] User story 2: "I want to post a message (peep) to chitter"
- [x] User story 3: "I want to see the date the message was posted"
- [x] User story 4: "I want to see a list of peeps in reverse chronological order"
- [ ] User story 5: "I want to filter on a specific keyword"

# README checklist

Does your README contains instructions for

- [ ] how to install,
- [ ] how to run,
- [ ] and how to test your code?
- [x] how to install,
- [x] how to run,
- [x] and how to test your code?

[Here is a pill](https://github.com/makersacademy/course/blob/main/pills/readmes.md) that can help you write a great README!
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To setup the database:
* Connect to psql
* Create the database using the psql command `CREATE DATABASE chitter;`
* Connect to the database using the psql command `\c chitter`;
* Run the query we have saved in the file 01_create_chitter_table.sql
* Run the queries saved in the files 01_create_chitter_table.sql and 02_add_date_to_peeps.sql
* Populate your table with a row by running `INSERT INTO peeps (message) values ('This is a peep!');`

To check you have everything set up ok, please take a look at the peeps table inside the chitter database. You should see one row in there.
Expand All @@ -25,13 +25,19 @@ To setup the test database:
* Create the database using the psql
command `CREATE DATABASE chitter_test;`;
* Connect to the database using the psql command `\c chitter_test`
* Run the query we have saved in the file 01_create_chitter_table.sql
* Run the queries saved in the files 01_create_chitter_table.sql and 02_add_date_to_peeps.sql

* `bundle install`
* `rspec`

You should see 1 passing test.

To run the app:
* `ruby app.rb`

To run tests:
* `rspec`

## User stories

```
Expand Down

0 comments on commit 215c139

Please sign in to comment.