Contributing to Scaladoc 2 is useful, fun and (relatively) easy.
- It is useful because there is a lot to do to improve Scaladoc, and because Gilles (that's me, the maintainer of Scaladoc), would rather spend his limited time improving Scala's structural types, or finishing the Scala reflection library.
- It is fun because hacking Scaladoc offers almost immediate GUI reward. Furthermore, because it is easy, you can send in patches quickly.
What should you contribute
You can look at the proposed changes for ideas of patches to contribute, or look at the tool bug list (note that some of the bugs in the list are related to the old Scaladoc and are not relevant to Scaladoc 2).
The proposed changes list is not an exhaustive catalogue of what can be improved in Scaladoc. As such, contributions for other features are also welcome. For the time being, I reserve the right to request changes to, or, in the worst case, reject contributions that go against the spirit of Scaladoc. Generally, it is preferable if you discuss your ideas on the bug or on the scala-internals mailing list.
Have a look at the top of this page for a list of what other work is happening on Scaladoc. You should probably pick something to contribute that isn't in this list. But if, for some reason, you want to contribute something that someone else is already working on, let me and the other person know.
Checklist for contributions
When you are ready to send your contribution, do the following:
- Check your contribution against the design guidelines to make sure that it fits (pay particular attention to the role of the model in the design).
- Check that your contribution is as small as possible, free of dead code, or of debugging output.
- Prepare a patch file (diff) against the head of the SVN trunk that can be applied at the root of the Scala repository (all files in the diff are relative to the Scala module root).
- Send me a mail with the patch and the necessary legal information, either:
- A sentence stating that you own the source and are contributing it to the Scala project (for short contributions), or
- A signed contributor license agreement (you have to send it once and it remains valid for further contributions).
The following people (in alphabetical order) have kindly contributed code to Scaladoc 2:
- Pedro Furlanetto
- Johannes Rudolph
- Damien Obrist
- and others!
Scaladoc 2 is based on older code written by the following people:
- David Bernard
- Vincent Cremet
- Manohar Jonnalagedda
- Stéphane Michleoud
- Sean McDirmid
- Geoffrey Washburn