Skip to content

Commit fd17e07

Browse files
committed
update readme
1 parent 9cf416c commit fd17e07

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

README.md

+28-16
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# Rails Legacy App
22

3-
In this lab you will dive into a mature rails application and attempt to fix some reported bugs. This lab will stretch your debugging skills and your ability to navigate a large rails project. We encourage you to tackle it in pairs.
4-
53
> This Rails application has been intentionally broken!
64
5+
In this lab you will dive into a mature rails application and attempt to fix some reported bugs. This lab will stretch your debugging skills and your ability to navigate a large rails project. It will also simulate a real-world scenario: contributing to an open source project.
6+
7+
We encourage you work together and tackle it in pairs.
8+
9+
710
### What's Publify?
811
You will be forking & cloning an open source (MIT LICENSE) blogging platform called Publify.
912

@@ -16,10 +19,6 @@ site, and Publish On your Own Site, Syndicate Everywhere.
1619
Publify has been around since 2004 and is the oldest Ruby on Rails open source
1720
project alive.
1821

19-
[![Build Status](https://travis-ci.org/publify/publify.png?branch=master)](https://travis-ci.org/publify/publify)
20-
[![Code Climate](https://codeclimate.com/github/publify/publify.png)](https://codeclimate.com/github/publify/publify)
21-
[![Dependency Status](https://gemnasium.com/publify/publify.png)](https://gemnasium.com/publify/publify)
22-
2322
#### Features
2423

2524
- A classic multi user blogging engine
@@ -39,17 +38,20 @@ project alive.
3938
- [Publify on Twitter](https://twitter.com/getpublify)
4039
- IRC: \#publify on irc.freenode.net
4140

41+
[![Build Status](https://travis-ci.org/publify/publify.png?branch=master)](https://travis-ci.org/publify/publify)
42+
[![Code Climate](https://codeclimate.com/github/publify/publify.png)](https://codeclimate.com/github/publify/publify)
43+
[![Dependency Status](https://gemnasium.com/publify/publify.png)](https://gemnasium.com/publify/publify)
44+
4245
## Getting Started: Installing Publify Locally
4346

4447
To install Publify you need the following:
4548

46-
- Ruby 2.0, 2.1 or 2.2
47-
- Ruby On Rails 4.2.0
48-
- A database engine, MySQL, PgSQL or SQLite3
49+
- [x] Ruby 2.0, 2.1 or 2.2
50+
- [x] Ruby On Rails 4.2.0
51+
- [x] A database engine, MySQL, PgSQL or SQLite3
4952

50-
- A compatible JavaScript installation for asset compilation. See [the execjs
51-
readme](https://github.com/sstephenson/execjs#readme) for details.
52-
- ImageMagick
53+
- [x] A compatible JavaScript installation for asset compilation. See [the execjs readme](https://github.com/sstephenson/execjs#readme) for details.
54+
- [ ] ImageMagick
5355

5456
#### Setup ImageMagick Dependency
5557
Make sure that you have ImageMagick installed (used by mini_magick).
@@ -100,14 +102,20 @@ $ rake db:seed
100102

101103
##The Bugs
102104

103-
The following issues have been added to the main github repo. Please fix each bug on its own branch (e.g. `fix_sidebar_styles`).
105+
A number of issues have been added to the main github repo. Please fix each bug on its own branch (e.g. `fix_sidebar_styles`).
104106

105-
> Please visit the `issues` section of this repo for more detailed bug descriptions + screenshots.
107+
> Make sure to visit the `issues` section of this repo for more detailed bug descriptions + screenshots.
106108
107109
####Issue \#1: Inconsistent Sidebar Styles
108110
* All titles in the sidebar should have `monospace` style font
109111
* All bullets should be circles.
110112

113+
####Issue \#8: Post tags are shown as "object"
114+
The list of tags associated with a given blog post always display "tags object, object, object".
115+
116+
####Issue \#7: Sign-in form displays raw span html in input fields
117+
The http://localhost:3000/users/sign_in page shows `<span class=` in the input fields, and other HTML "debris" below them.
118+
111119
####Issue \#2: Top Month Always Empty (Archive Sidebar)
112120
* When I click on the top-most month in the Archive Sidebar it says "No posts found...".
113121
* When I create a post in the _current month_ (e.g. February) it displays a link in the sidebar for _next month_ (e.g. March), and says "No posts found..."
@@ -116,11 +124,15 @@ The following issues have been added to the main github repo. Please fix each bu
116124
The sort order of months in the Archive Sidebar is off, with January 2015 appearing directly above December 2015:
117125

118126
### Resolving the Issue
119-
Please fix each bug on its own branch (e.g. `fix_sidebar_styles`). When you're finished with a bug, create a pull request from your fork back to the main repo.
127+
Please fix each bug on its own branch (e.g. `fix_sidebar_styles`).
128+
129+
When you're finished with a bug, create a pull request from your fork back to the main repo.
130+
131+
> Before you push, make sure to run `rubocop` to lint your ruby code and ensure it meets the standards established by this project.
120132
121133
<img width="1239" alt="example pull request" src="https://cloud.githubusercontent.com/assets/1489337/12763002/f2f3a6b6-c9a6-11e5-9e62-cff790c1a89a.png">
122134

123-
> Make sure to reference the issue you are resolving!
135+
> Make sure to reference the issue you are resolving! (You can even close an issue from inside your commit message!)
124136
125137
## Helpful Hints
126138
* Use **Rubber Duck Debugging** -- Make sure you understand the issue!

0 commit comments

Comments
 (0)