Add a HACKING.txt file.

Add a HACKING.txt file.

Move testing docs from the README.txt file to a new HACKING.txt, put deploying docs in README.txt .

https://code.launchpad.net/~teknico/charms/precise/juju-gui/1089028-add-hacking-file/+merge/139484

(do not edit description out of merge proposal)

[teknico, 2012-12-12 15:12:39]

Please take a look.

[gary.poster, 2012-12-12 21:26:32]

Land with changes.

Thank you Nicola.  Looks good.

Gary

https://codereview.appspot.com/6921049/diff/1/HACKING.txt
File HACKING.txt (right):

https://codereview.appspot.com/6921049/diff/1/HACKING.txt#newcode12
HACKING.txt:12: Unit tests
I guess to be consistent with the titles we talked about in the other review we
might as well follow standard title capitalization rules here too.  I don't feel
strongly about it, but we might as well be consistent.

https://codereview.appspot.com/6921049/diff/1/README.txt
File README.txt (right):

https://codereview.appspot.com/6921049/diff/1/README.txt#newcode21
README.txt:21: Finally, run the following commands::
Before this, I recommend introducing the idea of creating a file with the config
values you want.  It is required now, and probably still a good idea even after
bac fixes bug 1086507.

https://codereview.appspot.com/6921049/diff/1/README.txt#newcode24
README.txt:24: $ juju deploy juju-gui
This is where you would include the --config option, IIRC.

[benji, 2012-12-12 22:08:10]

Looks good.

https://codereview.appspot.com/6921049/diff/1/HACKING.txt
File HACKING.txt (right):

https://codereview.appspot.com/6921049/diff/1/HACKING.txt#newcode12
HACKING.txt:12: Unit tests
On 2012/12/12 21:26:32, gary.poster wrote:
> I guess to be consistent with the titles we talked about in the other review
we
> might as well follow standard title capitalization rules here too.  I don't
feel
> strongly about it, but we might as well be consistent.

This style is from me.  I have done titles this way since Fred Drake told me
that this is how publishers do it now.  I don't really care one way or the
other, but I am now curious to find a definitive -- or at least persuasive --
answer.

[gary.poster, 2012-12-12 22:22:50]

On 2012/12/12 22:08:10, benji wrote:
> Looks good.
> 
> https://codereview.appspot.com/6921049/diff/1/HACKING.txt
> File HACKING.txt (right):
> 
> https://codereview.appspot.com/6921049/diff/1/HACKING.txt#newcode12
> HACKING.txt:12: Unit tests
> On 2012/12/12 21:26:32, gary.poster wrote:
> > I guess to be consistent with the titles we talked about in the other review
> we
> > might as well follow standard title capitalization rules here too.  I don't
> feel
> > strongly about it, but we might as well be consistent.
> 
> This style is from me.  I have done titles this way since Fred Drake told me
> that this is how publishers do it now.  I don't really care one way or the
> other, but I am now curious to find a definitive -- or at least persuasive --
> answer.

It's the proper English way of capitalizing titles.  Take it from an English
teacher's son, or look up "capitalizing titles" on Google and it will have
articles referring to various standard manuals of writing style. :-)

[teknico, 2012-12-13 12:38:37]

gary.poster wrote:
> It's the proper English way of capitalizing titles.  Take it from
> an English teacher's son, or look up "capitalizing titles" on
> Google and it will have articles referring to various standard
> manuals of writing style. :-)

Not there yet, sorry. :-)

Title case "is considered correct in formal American English writing, according
to most style guides, though others are found in less formal settings."

"The convention followed by many British publishers, [...] sentence case, is
also widely used in the United States, especially in newspaper publishing,
bibliographic references and library catalogues."

http://en.wikipedia.org/wiki/Letter_case#Headings_and_publication_titles

I feel title case might not be the most effective choice for the tech docs of an
open source project. However, until you agree with me, it's still our choice and
I'll keep enforcing it (oversights notwithstanding).

[teknico, 2012-12-13 13:01:44]

*** Submitted:

Add a HACKING.txt file.

Move testing docs from the README.txt file to a new HACKING.txt, put deploying
docs in README.txt .

R=
CC=
https://codereview.appspot.com/6921049

[benji, 2012-12-13 13:17:29]

On Wed, Dec 12, 2012 at 10:22 PM,  <gary.poster@canonical.com> wrote:
> It's the proper English way of capitalizing titles.  Take it from an
> English teacher's son, or look up "capitalizing titles" on Google and it
> will have articles referring to various standard manuals of writing
> style. :-)

Yeah, I was aware that it was at least the prevailing style.  My copy of
_The Joy of Clojure_ has chapter headings with just the first word
captialized while _RESTful Web Services_ uses the "standard" way.

I don't actually care which we use, it is just interesting (to me at
least) that variation is found.
-- 
Benji York

[teknico, 2012-12-13 13:51:36]

*** Submitted:

Add a HACKING.txt file.

Move testing docs from the README.txt file to a new HACKING.txt, put deploying
docs in README.txt .

R=benji
CC=
https://codereview.appspot.com/6921049