Update contributing docs for new feature ideas #19428
Conversation
0dc5c53 to
f983f89
Compare
There was a problem hiding this comment.
I think we need sort out the differences between the flow chart and the kanban board
There was a problem hiding this comment.
Yes, but maybe that can happen in a follow-up PR? I'd prefer to get this landed sooner than later.
There was a problem hiding this comment.
Thank you for the updates! This looks good
I have added a couple of thoughts/questions. I think it would be good to get @nessita 's opinion also 👍
There was a problem hiding this comment.
Currently, we mostly use "Someday/Maybe" to track work that we do want to do but can't do now because we are waiting for a particular date (such as a final release to Python etc). Once that date is arrived, it becomes accepted but indicates to others that we can't merge something for this "yet"
I'm thinking either we leave this as it was or rewrite it 🤔 for it now to be called "old" is not strictly true as we're still using it
There was a problem hiding this comment.
@LilyFoote Could we change the original text from "It's used sparingly to keep track of high-level ideas or long-term feature requests." to "It's used sparingly to keep track of long-term changes."? We could add Sarah's example of a change being blocked by a final release to Python since that will be a consistent case too.
There was a problem hiding this comment.
I think this is a good idea
Maybe:
This stage isn't shown on the diagram. It's used sparingly to keep track of
long-term changes.
These tickets are uncommon and overall less useful since they don't describe
currently actionable issues.
I deleted the last sentence of the second paragraph and changed "concrete" to "currently"
These changes include: * Clarification of the new feature proposal and evaluation process. * Reodering "points to consider" into reporting bugs section, since these are mostly trac-specific. * Narrowing the guide on user interface bugs and features to just bugs. * Updating documentation for Someday/Maybe triage stage. Co-authored-by: Tim Schilling <[email protected]> Co-authored-by: Sarah Boyce <[email protected]> Co-authored-by: Natalia <[email protected]>
There was a problem hiding this comment.
I'm making some small tweaks and I'm downgrading this to a subsection, so it's shown under "reporting bugs" in the ToC.
There was a problem hiding this comment.
I feel "touches on" is weird when talking about bugs and code, so I'm changing this to "impacts".
There was a problem hiding this comment.
This change feels (to me) a bit more passive and subjective. The original phrasing encourages contributors to actively consider whether their feature belongs in core, which I think is clearer guidance. How about something more actionable like:
| * Be aware that your feature may not require changes in Django's core. If your | |
| * Evaluate whether the feature idea requires changes in Django's core. If your |
There was a problem hiding this comment.
I'm minimally rewording this, and I'm inclined to remove the "First", since there are no other "ordered" steps following this one. The next two bullet points feels more like sub items of this one...
There was a problem hiding this comment.
I don't think this is related to this PR, but this link feels unnecessary at this stage. The reader hasn't even requested the new feature yet or know whether it will be accepted yet we are linking on how to document it. I think we should replace it with a link to where the new feature ideas updated workflow is described, or if we don't have such doc, just remove this.
There was a problem hiding this comment.
This is good clarification but I think we should include where these reactions are expected. The top bottom flow in this doc does not make it obvious that we are referring to the new features ideas process in particular. I'll push a suggestion.
There was a problem hiding this comment.
All these mentions of Steering Council should not be an absolute link, these should be a local ref (I'll push a fix).
fbf9d85 to
fa2a203
Compare
Trac ticket number
N/A
Branch description
Updates the contributing documentation to be aware of the experimental new feature idea tracker introduced by the Steering Council.
Checklist
mainbranch.