-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Docs: Improve scoping of two potentially overlapping Triage sections #9302
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
76daf5f
to
dd1de34
Compare
It seems these two warnings are new
Probably used to be resolved via intersphinx... will have a look... |
…ped resources, fix cross-references, update Triage sections intro/scope
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me 👍🏼
One comment. Please, do not force push new commits if there is a review already done in the PR because that forces the reviewers to review all the files again since GitHub interprets as all the content is new. If there is a way to solve this problem involving force push I'm happy to know how, but I didn't find it. If you want to rebase/change history/etc you can do that immediately before merging the PR
This is done so that I - as a PR Author - can ensure that the commit history is nice and clean before a merge. There are several alternatives to the same goal:
Of course, there is also the option of keeping all the commits and merging the classic way.
This is not really true, you can see all comments and what segments of the code they belong to. All comments in this PR were outdated. Personally, I like to take a pragmatic approach and not see any of these as a mandatory option, as it raises the bar for contribution and makes it too easy for developers to have discussions 😄 |
I'm not talking about the comments, but the changes themselves. If you force push, when I go to "File changed" tab, GitHub shows me all the files again, instead of only the last changes since I reviewed this PR last time. So, I lost all the files I marked as "Viewed" and I'm not sure what changes from the last time I review the PR. |
:doc:`team`
referencing Write the Docs via intersphinxThis is a bit meta-level: Since I'm going over dev docs right now, I wonder how exactly this PR lands: It's a PR without an issue, so it's not actually triaged. Some projects prefer that an issue is always opened for discussion, some prefer that contributors have a shortcut by simply opening a PR.I believe that this is resolved, we keep things as they are, adding a bit more incentives on the triaging process.:doc:
or:ref:
to resolve to intersphinx mapping without:external:
prefix:external:
role in rstcheck