monterail / guidelines

[DEPRECATED] We are Ruby on Rails experts from Poland. Think hussars. Solid & winged. These are our guidelines.
71 stars 17 forks source link

Always put app installation instructions in the README #155

Closed porada closed 11 years ago

porada commented 11 years ago

…even if it’s just bundle install.

porada commented 11 years ago

This is my :love_letter: to @teamon.

cc @jandudulski, @sheerun, @chytreg, @szajbus, @Ostrzy, @jcieslar, @tallica

jandudulski commented 11 years ago

yes yes yes

sheerun commented 11 years ago

What if application does not require bundle install? :trollface:

jandudulski commented 11 years ago

The write "it just works, do nothing" :facepunch:

sheerun commented 11 years ago

What happened with bin/setup? :trollface:

jandudulski commented 11 years ago

If you prepare it, then you write "run bin/setup".

porada commented 11 years ago

@jandudulski gets it. :+1:

teamon commented 11 years ago

"When entering a new project, first thing to do is to check README for setup instructions and add them if missing"

porada commented 11 years ago

Wording doesn’t matter—what does is the fact that this should be back-end developers’ task, because the foundation is what they actually build.

teamon commented 11 years ago

What matters is note about what to do first with new project :)

porada commented 11 years ago

YAY FOR README DAY