Repository navigation
Improve state graph #184
Description
#182 made it a bit obvious that some edge descriptions are a bit too simple to properly convey what's going on, e.g. the "New PR" edge labels don't distinguish that in one case it's for PRs from core devs and the other is for everyone else. It would probably be good to touch up the graph to make it more self-evident how things are supposed to work.
Activity
lysnikolaou commentedon Oct 10, 2019
It might be a good idea to include an additional edge color for triager actions. Won't make too big of a difference right now, but it could come in handy in the future.
ssd71 commentedon Oct 16, 2019
I would like to work on this
lysnikolaou commentedon Oct 16, 2019
Hey @ssd71, you can go ahead and push a PR for this, when you are ready.
DanielNoord commentedon Jul 12, 2022
@brettcannon I'm not sure if the devguide was around when this issue was created but this information is now also stored on:
https://devguide.python.org/triage/labels/index.html
However, there isn't a flow graph there. Do we want to duplicate the information in this repository? Or do we want to move the graph over to the dev guide?
brettcannon commentedon Jul 12, 2022
@DanielNoord I don't think the devguide page existed when I opened this issue.
As for where a graph should go, it's an interesting question. If you view it as user documentation then the devguide is the best spot. But if you view it as documentation to help maintain the code, then here is best. And there's also the concern of the devguide's version becoming outdated (although I don't think the overall flow has changed much since it's initial design).
So unfortunately I don't have a good answer.
DanielNoord commentedon Jul 12, 2022
@brettcannon I think there is a higher chance of
bevedereand its docstrings becoming outdated than that of the devguide just based on the traffic that both attract.I'm not even sure the graph helps that much with current maintenance of the code. If something is unclear and a contributor can't discern the flow of labels from either the devguide or their descriptions on Github itself, that probably points to a lack of information there rather than an incomplete state graph.
I mean, I was able to follow most of the flow relatively easy by just looking at
cpythononce in a while. I don't even known this graph existed until today.I would be okay with removing it rather than trying to cover some edge cases, but that's obviously something for you to decide!
brettcannon commentedon Jul 12, 2022
It's actually for @Mariatta to decide as I have stepped down from maintaining Bedevere. 😁
hugovk commentedon Jul 13, 2022
If it is worth keeping, we could put it in Markdown in this repo and have it automatically rendered, using Mermaid:
https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/
ezio-melotti commentedon Jul 14, 2022
Note that this is not up-to-date and updating it is on my todo list. (see also CPython labels (view))
Cool! I didn't know about this.
ezio-melotti commentedon Aug 7, 2022
My plan is to:
I think readers of the devguide are more interested in the meaning of the currently applied label, rather than the full flow chart -- if they are curious they can always follow the link.
I'll add a couple of comments to make sure that changes are reflected in both places.