Re: [jdf-dev] Review needed: Contributor guide
Hi Pete,
It's a lot of information, but it's easy to follow. I think the level of
information and the writing style are just right.
I'm not sure about the accordion device for revealing the content. I do understand it
would look daunting and invoke the tl;dr effect if all the content was sitting there when
the page loads. However, when trying to read the whole thing in sequence, I had to scroll
back up to get to read the top of each section after clicking to reveal it. Not sure
what's better. A TOC page with multiple subpages and next/previous links? Just one big
page after all?
Finally, a few corrections:
* The text: We suggest updating the commit message to "Merge <Other Project
Name> '<Tag>'"
Comes out as: We suggest updating the commit message to "Merge ''"
(the angle brackets are being treated as HTML tags)
* Change "Each example lives in it's own repository" -> "Each
example lives in its own repository"
* Change "An example of it's usage" -> "An example of its
usage"
* Change "Release Proceedures" -> "Release Procedures"
* Change "./dist/release-utils.sh -r" to "dist/release-utils.sh -r"
-Jonathan
----- Original Message -----
From: "Pete Muir" <pmuir(a)redhat.com>
To: jdf-dev(a)lists.jboss.org
Sent: Monday, June 25, 2012 4:59:29 PM
Subject: [jdf-dev] Review needed: Contributor guide
All,
I've put http://www.jboss.org/jdf/stage/about/contributing/ up. It's a first draft
of a unified contributor guide for jdf.
I've included:
* setting up ruby etc. for building stuff
* contributing guidelines
* release process
The things I'm not sure of:
* is the location right (about/contributing, appearing in the About menu)?
* should we embed the relevant bits in examples/get-involved etc.?
* is the level of the info right (conveying relevant info, but not very hand holding)?
* is there content missing that we need.
Thanks!
_______________________________________________
jdf-dev mailing list
jdf-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/jdf-dev