#14401 closed (fixed)
Add a contributing HOWTO page for new contributors
| Reported by: | Gabriel Hurley | Owned by: | Gabriel Hurley |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Keywords: | contributing | |
| Cc: | Gabriel Grant | Triage Stage: | Accepted |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
There has been repeated talk of consolidating the "community wisdom" and "the spirit of contributing to Django" in a way that's more accessible and to-the-point for new users in a way that the current contributing docs may not be. Most recently Russell mentioned it in this thread:
http://groups.google.com/group/django-developers/browse_frm/thread/9ebc3e57d539d1ff
I would like to put such a page in the official docs together, and to that end I have created a wiki page to serve as the basis for the eventual patch:
Attachments (3)
Change History (13)
comment:1 by , 14 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:2 by , 13 years ago
| Cc: | added |
|---|
comment:3 by , 13 years ago
| Cc: | added; removed |
|---|
by , 13 years ago
| Attachment: | 14401_contributing_howto.diff added |
|---|
comment:4 by , 13 years ago
| Has patch: | set |
|---|---|
| Status: | new → assigned |
I've taken all of the contributions from the wiki page and turned them into a proper patch. The new document would live at /howto/contribute, which I think has a nice ring to it.
comment:5 by , 13 years ago
Looks good to me, Gabriel. I also agree that /howto makes sense as a location for this document.
My only comment would be that the patch possibly needs to include a light factor of the existing contribution docs to reduce the significance of the formal triage team. The triage team was an important part of the process a while back, but isn't any more; if we are adding a new, more friendly description of our process, we should ensure that it isn't inconsistent with our other process documentation.
by , 13 years ago
| Attachment: | 14401_contributing_howto.2.diff added |
|---|
comment:6 by , 13 years ago
Updated patch attached. This one reworks a few small bits of the existing contributing docs to do the following:
- Replace references to the "triage team" with information about triage by the community where possible.
- Remove references to the "triage team" altogether where no longer relevant.
- Encourage greater community participation by rephrasing some of the scarier language about triaging tickets.
I also re-wrapped a number of long lines in the document, which sadly makes it harder to review the changes to the actual text. I apologize for that.
comment:7 by , 13 years ago
The wrapping in that patch is strange - in many cases the first line of a paragraph is much shorter than it needs to be. And it general it seems to be wrapped to about 70 chars, when our guide says 80.
I've used the Emacs fill-paragraph command to re-wrap all the text in contribute.txt, attached.
Accepted on principle; the wiki page looks like a good start on a draft to me.
One activity that dovetails into this is modifying the wiki/reports page to include a better selection of Trac queries matching to useful activities. This document should then reference that page of queries.