From d903cf92208ed0d6ca9ef791ecb992fe973c7e08 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Thu, 17 Dec 2020 16:27:24 -0500 Subject: [PATCH 1/2] DOC: fix spelling in bug_triage page hat tip @qulogic who caught this in review as we are adapting this page for Matplotlib. --- doc/developers/bug_triaging.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/developers/bug_triaging.rst b/doc/developers/bug_triaging.rst index 2cd87590ca511..6917c092a9ded 100644 --- a/doc/developers/bug_triaging.rst +++ b/doc/developers/bug_triaging.rst @@ -36,7 +36,7 @@ The following actions are typically useful: Online discussions may be harder than it seems at first glance, in particular given that a person new to open-source may have a very - different understanding of the process than a seasonned maintainer. + different understanding of the process than a seasoned maintainer. Overall, it is useful to stay positive and assume good will. `The following article From f7bfc63c277ef92d5fcc8555f4cbd0ce7b1ce0c3 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Thu, 17 Dec 2020 16:29:12 -0500 Subject: [PATCH 2/2] DOC: straighten rst headers --- doc/developers/bug_triaging.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/developers/bug_triaging.rst b/doc/developers/bug_triaging.rst index 6917c092a9ded..ff96ec9f0faae 100644 --- a/doc/developers/bug_triaging.rst +++ b/doc/developers/bug_triaging.rst @@ -1,7 +1,7 @@ .. _bug_triaging: Bug triaging and issue curation -================================ +=============================== The `issue tracker `_ is important to the communication in the project: it helps @@ -10,7 +10,7 @@ priorities. For this reason, it is important to curate it, adding labels to issues and closing issues that are not necessary. Working on issues to improve them --------------------------------------- +--------------------------------- Improving issues increases their chances of being successfully resolved. Guidelines on submitting good issues can be found :ref:`here @@ -44,14 +44,14 @@ The following actions are typically useful: explores how to lead online discussions in the context of open source. Working on PRs to help review ------------------------------- +----------------------------- Reviewing code is also encouraged. Contributors and users are welcome to participate to the review process following our :ref:`review guidelines `. Triaging operations for members of the core and triage teams -------------------------------------------------------------- +------------------------------------------------------------ In addition to the above, members of the core team and the triage team can do the following important tasks: @@ -91,7 +91,7 @@ See the github description for `roles in the organization should be closed. A typical workflow for triaging issues ----------------------------------------- +-------------------------------------- The following workflow [1]_ is a good way to approach issue triaging: