Merge lp:~jml/launchpadlib/hacking-documentation into lp:launchpadlib

[Jonathan Lange]

The HACKING.txt linked to a not-very-useful page on the Launchpad wiki. After being told that there *is* a useful page, I decided to update the documentation here.

[Raphaël Badin (rvb)]

review: Approve (code*)

[Robert Collins (lifeless)]

the not very useful page has a link to the useful page, and also talks
about coding style etc. I'm ambivalent about this change at best.

[Gavin Panella (allenap)]

review: Approve

[Jonathan Lange (jml)]

On Thu, Sep 15, 2011 at 1:40 PM, Robert Collins
<email address hidden> wrote:
> the not very useful page has a link to the useful page, and also talks
> about coding style etc. I'm ambivalent about this change at best.

The HackingLazrLibraries page links back to Hacking as well. As a
page, Coding style can often be inferred from the surrounding code,
whereas testing, landing and release processes are harder to figure
out.

The Hacking page is full of information that is not at all relevant to
hacking on lazr libraries. (e.g. Storm, Security and Authentication,
Web UI, Celebrities, Launchpad configuration). Having it linked from
HackingLazrLibraries, which becomes the primary landing page for lazr
hacking documents.

jml

[Jonathan Lange (jml)]

On Thu, Sep 15, 2011 at 1:55 PM, Jonathan Lange <email address hidden> wrote:
> On Thu, Sep 15, 2011 at 1:40 PM, Robert Collins
> <email address hidden> wrote:
>> the not very useful page has a link to the useful page, and also talks
>> about coding style etc. I'm ambivalent about this change at best.
>
> The HackingLazrLibraries page links back to Hacking as well. As a
> page, Coding style can often be inferred from the surrounding code,
> whereas testing, landing and release processes are harder to figure
> out.
>
> The Hacking page is full of information that is not at all relevant to
> hacking on lazr libraries. (e.g. Storm, Security and Authentication,
> Web UI, Celebrities, Launchpad configuration). Having it linked from
> HackingLazrLibraries, which becomes the primary landing page for lazr
> hacking documents....

Oops.

"Having it linked from HackingLazrLibraries, which then becomes the
primary landing page for lazr hacking documents, makes it available as
a reference and more clearly indicates that Hacking is of less direct
relevance."

jml

[Gavin Panella (allenap)]

Gah, I even read HackingLazrLibraries as I landed it, but somehow forgot to put "Landed on behalf of ..." in the commit message. Earnest apologies, I promise I was not trying to steal the limelight :)

[Jonathan Lange (jml)]

On Thu, Sep 15, 2011 at 4:23 PM, Gavin Panella
<email address hidden> wrote:
> Gah, I even read HackingLazrLibraries as I landed it, but somehow forgot to put "Landed on behalf of ..." in the commit message. Earnest apologies, I promise I was not trying to steal the limelight :)

No worries :) Just happy to have it landed.

jml

=== modified file 'HACKING.txt'
--- HACKING.txt	2009-09-28 18:53:10 +0000
+++ HACKING.txt	2011-09-15 11:02:28 +0000
@@ -22,7 +22,10 @@
 These are guidelines for hacking on the lazr.launchpadlib project.  But first,
 please see the common hacking guidelines at:
 
-    http://dev.launchpad.net/Hacking
+    https://dev.launchpad.net/HackingLazrLibraries
+
+These guidelines will tell you how to run the tests, use in-development
+versions of libraries, land your branches and get them released.
 
 
 Getting help