harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Mark Wielaard <m...@klomp.org>
Subject Re: [project policy] Author credit and attribution
Date Sun, 02 Oct 2005 10:04:55 GMT

If you are looking for some guidelines for working together on code and
how to keep track of who wrote what when then I would recommend starting
out with our GNU Classpath Hacker Guide. Specifically chapter 7.
"Working on the code, Working with others". It explains that the main
rule is to always explain and discuss everything on the patches
mailinglists. No commit is made before it has been posted first.

Just following that main rule makes sure that everybody knows what and
why things happen. Next there are all kinds of practical guidelines such
as maintaining a clear and concise ChangeLog for every commit. Splitting
commits for unrelated code changes, or changes to code and changes to
formatting, etc for clarity. And when to ask for permission to commit a
change. Also important is to always use the same code style guide (see
chapter 6) so that the code looks like it is part of a whole.

There is currently no strict rule about "author tags". Some people add
them some don't. This isn't really a problem. The ChangeLog file
documents in very precise detail who really wrote what (and of course
CVS has a similar record if you happen to be online). And there is a
AUTHORS file listing all active hackers and a THANKS file for
documenting who else helped out with bug reports, hints or moral
support. Also the release announcements always include a full list of
all contributors and a summary of their contributions.

Currently there are about 80 committers creating around 15 patches a
day. And the Hacker Guide really helps to keep some structure to the
project without being so strict that it makes contributing difficult.



View raw message