collect documentation about how to be a Scala module maintainer

[SethTisue]

we should really collect this stuff in one place, and this repo seems like the logical place

see e.g. the comments at scala/scala-swing#51 — there is info from me about the expected commitment level to be a community maintainer, info on tagging and publishing, info from @andy1138 on CLA checking, etc

we've also held other maintainers' hands on this stuff (e.g. @biswanaths, @ashawley, @gourlaysama)

would someone like to volunteer to add the basic info to the README? it doesn't need to be super comprehensive or elaborate, just basics. in the long run we can grow and refine it

[SethTisue]

in addition to how-to information about what to do once you are already a maintainer, it could also include information about what being a maintainer even involves, for people considering volunteering. then we could add "volunteers wanted" links to it from the module READMEs

see e.g. @adriaanm's remarks at scala/scala-xml#60

[adriaanm]

There should be, but I don't recall any :-/

[SethTisue]

for the eventual doc: in addition to tagging and publishing, doing a module release should involve updating the module repo's "Releases" page so the release is marked as the latest release and includes release notes. see e.g. https://github.com/scala/scala-xml/releases . (I had to remind a new module maintainer about this recently.)

[SethTisue]

there are some nice docs here https://github.com/scala/scala-parallel-collections/blob/master/admin/README.md

[SethTisue]

some perhaps usable material or ur-material is here: scala/scala-swing#65 (comment)

[ashawley]

I've written down some notes specific to scala-xml on the wiki that probably overlaps with other modules:

• https://github.com/scala/scala-xml/wiki/Contributor-guide
• https://github.com/scala/scala-xml/wiki/Maintainer-guide

I haven't made notes on anything about releases, but I'll probably make a separate guide for that.

[SethTisue]

about the CLA, previously: scala/scala-swing#51 (comment) so I think the status quo is that contributors are supposed to sign the CLA but we don't have automation for it in the module repos. this came up again at scala/scala-swing#68

[SethTisue]

how much freedom do module maintainers have to make changes? I wrote some remarks on this just now at scala/scala-swing#76 (comment)

[SethTisue]

@ashawley's scala/scala-xml#225 shows how to publish module Scaladoc to scala.github.io