This is part of the merge of TWiki.org docs into Dakar develop, Item663
Current Dakar develop: The AUTORS table lists just the name and country of the contributor.
Pre Dakar: TWiki:TWiki/TWikiContributor
lists also the area of contributions.
I think it is important to do that also for Dakar because:
- Show who is expert in what field
- Distinguish between a one time contribution and many years of contribution
For example, compare contributions on two sides of the spectrum:
| David Sachitano TWiki:Main.DavidSachitano
|| FORMFIELD variable
| John Talintyre TWiki:Main.JohnTalintyre
|| TWiki:Codev.CoreTeam member, author of attachment under revision control, rename/move topics and attachments, inventor of meta data format, search improvements, easier install for Windows, storage backend architecture, Plugin API enhancements, TWiki Forms for user preferences
I think it is nothing but fair that John gets attributed for all his contributions.
And what about those of us who contributed no code, not documentation, but did testing?
Should be stated as such.
I think this would be fantastic, but form what i can see, no-one has the time to implement it properly, so we've gone with the vaguer approach. If anyone has a patch to list everyone
with more detailed information, it would be great - other wise, its unlikely to be done for this release
thus i'm chainging it to enhancment
already lists area of contribution for many contributors. I suggest to use that (and add whatever we know of other folks). It does not matter if there are some names not listing area of contribution.
has a record of contributors and what they did (well, to the extent that people use meaningful checkin comments). when i checkin someone else's patch, i'm sure to credit them in the checkin comment.
That information is not available in the downloaded package.
hmm, it's supposed
to be, so i'm changing this to an active build bug.
It is of more value to get a big picture view of who contributed what.
Nobody is going to scan over a detailed change log that is auto-generated.
Hence the reason to list the area of contribution as done in
I would like to see actioning on this. It does not take much time to copy/paste/proof this.
A few weeks later, no actions. I will make this change eventually if nobody helps on the docs. Please note that I have lots of other doc work pending.
I think it makes sense to move the contributor content from CONTRIBUTORS into the TWiki.TWikiContributor
topic and change the build to copy the file the other way around. That way it is easier to maintain that content. See also related Item1256
Time for me to say something here.
I am absolutely not
going to do anything on this, because I disagree with this approach. Why? A number of reasons:
- Many (most?) contributions are lost in the mists of time,
- The relevance of contributions diminish as time goes on, and huge swathes of code are rewritten, often from the ground up,
- There are many indirect contributions. Example: Anton would not be listed as the author of any code or documentation, but his influence over design is considerable. So how do you record his contribution? As a "maker of many useful comments". Gee, that really doesn't capture it; but to say nothing is to completely devalue his contribution,
- Works may have been coded by one person, but many, many people have influenced the decisions taken during that process. Where is their recognition?
- Often the person writing the contributors topic doesn't know or appreciate the full extent of a contribution (I have been caught out this way myself, writing the dakar release notes. And there have been several by-proxy contributions from within corporations who do not want to be identified, which could result in the wrong person - whoever checked it in - being accredited).
I elected to list specific contributions to DakarRelease
in the release notes
. That acknowledges their contribution to the release, while also clearly time-bounding the contribution. Individuals are also free to list their contributions in their personal topics on twiki.org (their CVs, if you like). But IMHO trying to summarise those contributions on a person-by-person basis in a time-independant way
, highly likely to be inaccurate
, has a high risk of causing offence
, and imposes a huge maintenance burden
(the Cairo list was woefully
inaccurate, bearing testament to this).
Discarding, because I believe it should be discarded. TWiki.org is the right place for this sort of thing, not the release package.
I would like to discuss this in the next release meeting.
. Majority verdict was to keep contribution detail out
of the release. Individual contributions are already documented in DakarReleaseNotes
, but Peter still wants to duplicate it into TWikiHistory
, an idea which was accepted in a spirit of compromise.