On Sun, Nov 10, 2013 at 2:25 AM, Jody Garnett <[email protected]>wrote:
> Thanks Andrea, the content looks fine.
>
> Even then I think we could lighten up that page as it serves too many
> purposes right now - it is trying to document the role contributor and the
> responsibility that goes along with that. It has now gotten distracted into
> being "contributor guidelines" first with different size contributions, and
> now pull requests.
>
The current documentation is too large and too dispersed, very few people
will have the patience to read it.
What we need is one page that contains all the information someone itching
to contribute to GeoTools need to know,
and that can be read in under 5 minutes.
I've hacked an existing page, it could be a new one, the important thing
is, one does not need to have to hunt around
for information like in the current guide, so the page should contain all
that's needed (including pointers) to get started.
Trying to be analytic and split stuff apart again would just defeat the
purpose and send us back to the current situation,
where nobody is really reading the existing docs (as said, the info is
there, just hard to locate and takes too much
time to read).
>
> Our page on pull requests is a similar muddle, but is a better place for
> talk first policy:
> http://docs.geotools.org/latest/developer/procedures/pull_requests.html
>
> In addition to the README we can provide a link from
> http://geotools.org/getinvolved.html.
>
I did add a link side by side to the link to "get involved" at
http://docs.geotools.org/.
As stated above, the causal contributor will not try to read the docs, will
quickly scan and if nothing
is found, will go down and make the patch by himself.
There's one thing that needs to be made clear here in my opinion: a person
skilled enough to propose a GeoTools
change is not very likely to read the docs, but more likely to be
comfortable looking at code.
That's why a single, very evident page, is likely the only thing they'll
ever read
Cheers
Andrea
--
==
Our support, Your Success! Visit http://opensdi.geo-solutions.it for more
information.
==
Ing. Andrea Aime
@geowolf
Technical Lead
GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
fax: +39 0584 1660272
mob: +39 339 8844549
http://www.geo-solutions.it
http://twitter.com/geosolutions_it
-------------------------------------------------------
------------------------------------------------------------------------------
November Webinars for C, C++, Fortran Developers
Accelerate application performance with scalable programming models. Explore
techniques for threading, error checking, porting, and tuning. Get the most
from the latest Intel processors and coprocessors. See abstracts and register
http://pubads.g.doubleclick.net/gampad/clk?id=60136231&iu=/4140/ostg.clktrk
_______________________________________________
GeoTools-Devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/geotools-devel
