mozilla / playdoh

PROJECT DEPRECATED (WAS: "Mozilla's Web application base template. Half Django, half awesomeness, half not good at math.")
BSD 3-Clause "New" or "Revised" License
710 stars 107 forks source link

document maintenance policies #166

Closed willkg closed 10 years ago

willkg commented 10 years ago

Playdoh and its extended family are complex enough that they really need a maintenance document that covers how to maintain playdoh. It should have at least the following sections:

  1. how to update things in playdoh-lib (adding new lib via git submodules, adding new lib via pip, updating lib via git submodules, updating lib via pip)
  2. process for changing something (write up an issue, create a pull request, submit pull request, get a review, someone presses merge button)
  3. how to test changes to playdoh and friends

What else needs to be documented?

fwenzel commented 10 years ago

Like this? http://playdoh.readthedocs.org/en/latest/packages.html

willkg commented 10 years ago

That vaguely covers parts of item 1, but it's buried, poorly worded and it's really talking about how it was initially created a while back and not focused on "how do we maintain playdoh, playdoh-lib and funfactory".

Now that I know about that, I'll pull it into a new maintenance document.

fwenzel commented 10 years ago

<3

willkg commented 10 years ago

https://github.com/mozilla/playdoh-docs/pull/27

pmclanahan commented 10 years ago

Since mozilla/playdoh-docs#27 is merged, is this closed?

willkg commented 10 years ago

Yes! Sorry about that.