Document using Github issues as the issue tracker #814
Conversation
index.rst
Outdated
| @@ -304,8 +304,8 @@ Full Table of Contents | |||
| documenting | |||
| silencewarnings | |||
| fixingissues | |||
| tracker | |||
| triaging | |||
| tracker2 | |||
There was a problem hiding this comment.
Just curious of the renaming from tracker to tracker2. Is this because we're keeping a backup of the old tracker document? Does 2 means like version 2 or something?
There was a problem hiding this comment.
I think @ambv did that so it's easier to review the new document as a whole, because it's nearly a full rewrite. Unfortunately, GitHub in the review pane shows a diff between tracker and tracker2 anyway.
There was a problem hiding this comment.
Yes, @JelleZijlstra is right. Git itself is trying to be too smart here but fortunately I foresaw this and the deletion is a separate commit. So if you only look at 699f8f1, it reads easier.
There was a problem hiding this comment.
I left a few comments but haven't fully reviewed the triaging2 page, since it shows up as a whole new file and it's hard to tell what changed from the original page. It might be better to just edit the original pages instead of creating new files.
I think it would be better to divide the FAQ/docs in 2-3 sections:
- the migration (what has been transferred, how bpo things map to GitHub, etc.)
- GitHub issues in general (general guidelines and tips about using GitHub issues)
- CPython-specific guidelines (labels, templates, workflows, actions, etc.)
Currently the FAQs are a mix of the first two, but it would be better to separate them. For example, the "Where is the 'nosy list'?" explains how to subscribe to issues. This is useful for bpo users, but also for new users, except that they wouldn't know what the "nosy list" is and might have a hard time finding out that answer.
With two separate sections you could have "How do I subscribe/follow an issue?" FAQ in the "Using GitHub" section and then a "Where is the 'nosy list'?" FAQ in the "GitHub for BPO users" section that links to it.
Some CPython-specific guidelines are already covered in the triaging and tracker pages instead, so they don't necessarily have to be in the FAQ (even though there could be FAQs linking to the relevant sections, or some sections could be converted into FAQ).
tracker2.rst
Outdated
| * **Tests**: something is wrong with CPython's suite of regression tests; | ||
| * **Discuss**: you'd like to learn more about Python, discuss ideas for | ||
| possible changes to future Python versions, track core development | ||
| discussions, or join a specific special-interest group. |
There was a problem hiding this comment.
Are these already in place?
ambv
force-pushed
the
github-issues
branch
2 times, most recently
from
e8a07db
to
16cdc62
Compare
This change should be landed once issues are migrated from BPO to Github issues. Some information here is based on psf/gh-migration#13 and PEP 588.
The bulk is in
tracker.rstandtriaging.rst. Since they must make sense in their entirety, I temporarily deleted the old versions of those files and created new ones so that they can be reviewed without confusing diffs.