Skip to content
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

Add issue triage documentation #2236

Merged
merged 5 commits into from
May 16, 2021
Merged

Add issue triage documentation #2236

merged 5 commits into from
May 16, 2021

Conversation

ichard26
Copy link
Collaborator

A dump of all of my knowledge in this space :) This should hopefully make it easier for newer contributors to take on the neverending work of issue triage. Also add sphinx-copybutton so our code blocks are easily copiable and also add the missed Pipfile aiohttp-cors modification


Preview available here: https://ichard26-testblackdocs.readthedocs.io/en/issue-triage-docs/contributing/issue_triage.html

cc @cooperlees I added my saved replies thanks to your idea!

ichard26 added 2 commits May 15, 2021 14:56
A dump of all of my knowledge in this space :) This should hopefully make
it easier for newer contributors to take on the neverending work of issue
triage.
+ and also add the missed Pipfile aiohttp-cors modification
@ichard26 ichard26 added T: documentation Improvements to the docs (e.g. new topic, correction, etc) skip news Pull requests that don't need a changelog entry. C: maintenance Related to project maintenance, e.g. CI, testing, policy changes, releases labels May 15, 2021
@felix-hilden
Copy link
Collaborator

I had a read, and the docs seem very thourough to me. And sphinx-copybutton seems like a neat addition to the docs in general!

Copy link
Collaborator

@JelleZijlstra JelleZijlstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks! Left some notes

docs/contributing/issue_triage.md Outdated Show resolved Hide resolved
docs/contributing/issue_triage.md Outdated Show resolved Hide resolved
docs/contributing/issue_triage.md Outdated Show resolved Hide resolved
docs/contributing/issue_triage.md Show resolved Hide resolved
docs/contributing/issue_triage.md Show resolved Hide resolved
ambv and others added 3 commits May 16, 2021 17:59
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@ambv ambv merged commit 403ce1a into psf:main May 16, 2021
@ichard26
Copy link
Collaborator Author

I'm assuming we're getting ready for a new release soon since this was merged without resolving all of Jelle's suggestions. Don't worry, I'll add them after, but TBH a bit surprised 😕

Oh and I just got up so that's why I was unable to resolve them before.

@ambv
Copy link
Collaborator

ambv commented May 16, 2021

@ichard26 I'm adding them in a separate commit because the GitHub editor was clunky for this due to long lines.

@ambv
Copy link
Collaborator

ambv commented May 16, 2021

60f8bd2

@ichard26
Copy link
Collaborator Author

Fair enough, I guess a difference in workflows then since I do all documentation work locally (even with suggestions usually) so I don't mind tricky suggestions.

Thank you though!

@ichard26 ichard26 deleted the issue-triage-docs branch May 16, 2021 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: maintenance Related to project maintenance, e.g. CI, testing, policy changes, releases skip news Pull requests that don't need a changelog entry. T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants