Opened 13 years ago
Last modified 13 years ago
#15796 closed Bug
Contributing docs need to be updated to include new triage stages and ticket states — at Version 1
| Reported by: | Russell Keith-Magee | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | 1.2 |
| Severity: | Release blocker | Keywords: | |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description (last modified by )
Recent changes to Trac add a type and severity option, and a Needs Info triage state, However, these are currently undocumented.
Marking this as a release blocker because it's a documentation flaw in our main contribution process.
Note:
See TracTickets
for help on using tickets.
I see that the "needsinfo" resolution is already documented here: http://docs.djangoproject.com/en/dev/internals/contributing/
This makes me realise that there's a lot of overlap between http://docs.djangoproject.com/en/dev/internals/contributing/ and http://docs.djangoproject.com/en/dev/howto/contribute/
The former is also very dense as it contains tons of loosely related info like reporting bugs, code style, committing patches, branch policies, etc.
The Trac report (http://code.djangoproject.com/wiki/Reports) is also very useful and would, I think, deserve to be fleshed out more and then be integrated in the official Django doc itself to provide concrete examples and hints on how to contribute code.
I'm not sure how to do it yet, but it feels that we should perhaps rearrange everything into a more logical structure and with less duplicate information. Do you agree in principle? If so then I'm keen to have a go at it.
This ticket only asks for the few small doc fixes but I'm just wondering if we should maybe go for a bigger change while we're at it. Or maybe it's best to take this over to a separate ticket. Let me know what you think. Thanks!