search

thoughtbot / carnival

An unobtrusive, developer-friendly way to add comments
MIT License
499 stars 30 forks source link

Clean up the scaffold #103

Closed pbrisbin closed 10 years ago

pbrisbin commented 10 years ago

A site generated by yesod init comes with a number of explanatory comments and various settings which are not required.

Normally, I suggest keeping this content because when a new version of Yesod comes out, it is easy to scaffold out a new site and compare file-by-file for what you might want to update in yours. If you change your site significantly, such diffs are almost useless.

Yesod has stabilized quite a bit since 1.0 and I would now recommend against that. Instead, when a new version comes out I would just update, fix compiler errors and deprecation warnings, and take a look at change-logs for anything new we might want to take advantage of.

In that spirit, I'd like to go through the current codebase and rip out as much of that cruft as we can.

We could do this ahead of the 1.4 release then use that upgrade as a test to see if removing this content makes the upgrade more or less difficult.

pbrisbin commented 10 years ago

Decided to hold off on this until after the 1.4 update -- we'll try to evaluate if leaving this content here makes that easier, rather than evaluating if taking it out doesn't make it any harder.