Opened 5 years ago

Closed 5 years ago

#15796 closed Bug (fixed)

Contributing docs need to be updated to include new triage stages and ticket states

Reported by: russellm Owned by: julien
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:

Description (last modified by julien)

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.

Attachments (2)

15796.contributing-doc-refactor.diff (158.9 KB) - added by julien 5 years ago.
15796.contributing-doc-refactor.2.diff (159.0 KB) - added by julien 5 years ago.

Download all attachments as: .zip

Change History (12)

comment:1 Changed 5 years ago by julien

  • Description modified (diff)

I see that the "needsinfo" resolution is already documented here:

This makes me realise that there's a lot of overlap between and
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 ( 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!

comment:2 Changed 5 years ago by julien

Just to be a bit clearer about my proposal: Keep the (awesome) code contributing howto guide ( and update it with the recent Trac changes. Then remove all the triaging info from and merge the relevant parts into the howto guide. And then restructure and then potentially split it in multiple standalone sections (like the current howto guide is).

comment:3 Changed 5 years ago by julien

  • Easy pickings unset
  • Owner changed from nobody to julien

After discussing with Russell I'll take a stab at rejigging the contribution doc as enunciated above. Wish me luck :-)

Changed 5 years ago by julien

comment:4 Changed 5 years ago by julien

  • Has patch set

This was a big patch so I took it to the dev-list for feedback:

comment:5 Changed 5 years ago by jezdez

It's not correct anymore to point to Jacob to add a blog to the community section since the community-redux refactor landed. You can simply add your feed yourself.

comment:6 Changed 5 years ago by jezdez

  • Triage Stage changed from Accepted to Ready for checkin

Content wise it's great stuff, marking it as RFC.

comment:7 Changed 5 years ago by julien

Thanks Jannis, well spotted! Let me just quickly fix that as well as a couple of small things that were suggested on the dev-list. Will post a new patch shortly.

Changed 5 years ago by julien

comment:8 Changed 5 years ago by julien

OK, I've made those little fixes. By the way, you can browse the html output here:

Thank you!

comment:9 Changed 5 years ago by jezdez


comment:10 Changed 5 years ago by jezdez

  • Resolution set to fixed
  • Status changed from new to closed

In [16284]:

Fixed #15796 -- Restructured the contributing documentation and added note about newly added Trac abilities. Many thanks to Julien Phalip.

Note: See TracTickets for help on using tickets.
Back to Top