ARROW-17322: [Docs] Documenting issue lifecycle for bugs and feature requests #13781

toddfarmer · 2022-08-02T17:53:43Z

These changes aim to document the issue lifecycle - how to create new issues (largely already existed) as well as how to engage with and understand issue state later on. This also serves to document proposed processes:

Assigned issues idle more than 90 days may be unassigned (discussed and approved on ML)
Unassigned issues in "In Progress" status should be set to "Open"
Establishing consistent usage of Status and Resolution fields.

toddfarmer · 2022-08-02T17:58:23Z

docs/source/developers/bug_reports.rst

+  the issue and starting progress. Issues in this state should be unassigned.
+* **In progress** - At the time a contributor self-assigns an issue, the status
+  should be set to In progress by clicking the **Start progress** button. All
+  issues in this status should have an assignee - unassigned issues will be


NOTE: This details a newly proposed project policy - that any issues that have a status of "In Progress" but lack an assignee should be reverted to "Open" status. This prevents issues from being misrepresented as "In Progress" when there is nobody actually working the issue. This is likely to be automated, and while manual inspection of an issue in such a state may indicate somebody is likely working the issue (e.g., adding comments, etc.) but neglected (or cannot) self-assign, that may not be recognized in an automated process. Any automation should include a comment when changing the status from "In Progress" to "Open" for this reason, guiding any affected users on how to self-assign if appropriate.

toddfarmer · 2022-08-02T18:03:30Z

docs/source/developers/bug_reports.rst

+  * Implemented
+  * Done
+
+* **Closed** - Another terminal status, Closed indicates the issue is complete,


NOTE: Resolution codes have not been consistently applied historically. See this analysis for more details, and to comment on proposal to standardized and clean existing resolution code data. The resolution codes listed here eliminate several codes that have been previously used, and aims to standardize usage for clarity.

Right, the problem here is there are too many possible choices with no one being obviously better than the others in some situations :-)

toddfarmer · 2022-08-02T18:08:04Z

The attached .zip file contains the complete HTML page to help with review:
Bug reports and feature requests — Apache Arrow v9.0.0.zip

raulcd

Thanks @toddfarmer ! Minor comment from me

raulcd · 2022-08-03T12:50:59Z

docs/source/developers/bug_reports.rst

+`create an ASF Jira account here <https://issues.apache.org/jira/secure/Signup!default.jspa>`_.
+Self-assigning issues to work requires
+the "Contributor" permission. This permission is set by project maintainers,
+and may be requested by emailing the dev mailing list.


Should we add the full email address? As a new user reporting an issue it might not be clear where to find the dev mailing list.

Suggested change

and may be requested by emailing the dev mailing list.

and may be requested by emailing the `dev@arrow.apache.org <https://mail-archives.apache.org/mod_mbox/arrow-dev/>`_ mailing list.

Good idea! I changed this to point to the mailing list section of the communication page, just because I'm not sure of the mechanics of a non-subscriber emailing the dev@ list (will it go through? will they see any reply?).

kou · 2022-08-05T00:02:39Z

Could you open a JIRA issue for this?
This is not a minor fix: https://github.com/apache/arrow/blob/master/CONTRIBUTING.md#minor-fixes

Grammar, usage and spelling fixes that affect no more than 2 files

Documentation updates affecting no more than 2 files and not more than 500 words.

github-actions · 2022-08-05T16:15:22Z

https://issues.apache.org/jira/browse/ARROW-17322

toddfarmer · 2022-08-05T16:16:36Z

Could you open a JIRA issue for this? This is not a minor fix:

Happy to, thanks for the prompt: ARROW-17322.

kou

+1

docs/source/developers/bug_reports.rst

Co-authored-by: Sutou Kouhei <[email protected]>

kou

I'll merge this after a few days to wait for comments from others.

docs/source/developers/bug_reports.rst

Co-authored-by: Sutou Kouhei <[email protected]>

docs/source/developers/bug_reports.rst

pitrou · 2022-08-18T16:59:02Z

docs/source/developers/bug_reports.rst

+  closed, including during review of pull requests.
+* **Resolved** - This is a terminal status indicating action has been taken
+  on the issue, which is now considered completed. Issues in a resolved status
+  may have the following resolution codes set:


We should really always use "Fixed" for consistency, IMHO.

Is that true for non-defect issues (e.g., feature requests)? If a status of "Resolved" should map to a resolution of "Fixed" 100% of the time, that's easy enough to automate (in addition to document).

Yes, it is. The merge script does that. Besides, I don't think "Implemented" or "Done" would convey any useful subtlety compared to "Fixed".

Hmm, I'm not entirely sure what to make of ARROW-16790 in this context. The PR was merged, but the resolution is "Resolved" instead of "Fixed".

I've updated this page to direct usage of "Fixed" when resolving an issue. I scanned this list for examples where that's not set, and it seems to mostly be manually-set resolutions, either using a status of "Resolved" when it should be more properly be "Closed" (e.g., "Information Provided" or "Won't Fix" resolutions), or because the issue was resolved by work done on a different issue (and the PR referenced the other issue, not the one with the incorrect resolution).

ARROW-16790 should ideally be marked "Fixed". But it seems that would require reopening the issue... let's not bother with this one perhaps.

docs/source/developers/bug_reports.rst

Co-authored-by: Antoine Pitrou <[email protected]>

AlenkaF

Two small comments regarding the self-assignment of an issue.

AlenkaF · 2022-08-22T10:06:46Z

docs/source/developers/bug_reports.rst

+`create an ASF Jira account here <https://issues.apache.org/jira/secure/Signup!default.jspa>`_.
+Self-assigning issues to work requires
+the "Contributor" permission. This permission is set by project maintainers,
+and may be requested by emailing the :ref:`development mailing list <mailing_list>`.


There is no need for a contributor permission to self-assign Jira issues anymore, if I understand correctly.

Updated to reflect this change - thanks!

docs/source/developers/guide/step_by_step/finding_issues.rst

Co-authored-by: Antoine Pitrou <[email protected]>

Co-authored-by: Alenka Frim <[email protected]>

…equired for Resolved status

pitrou

Thanks for the updates @toddfarmer !

ursabot · 2022-08-24T09:01:45Z

Benchmark runs are scheduled for baseline = c90d07f and contender = d53bce2. d53bce2 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️25.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Failed ⬇️1.11% ⬆️0.0%] test-mac-arm
[Failed ⬇️0.0% ⬆️0.0%] ursa-i9-9960x
[Failed ⬇️0.0% ⬆️0.0%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] d53bce20 ec2-t3-xlarge-us-east-2
[Failed] d53bce20 test-mac-arm
[Failed] d53bce20 ursa-i9-9960x
[Failed] d53bce20 ursa-thinkcentre-m75q
[Finished] c90d07f7 ec2-t3-xlarge-us-east-2
[Failed] c90d07f7 test-mac-arm
[Failed] c90d07f7 ursa-i9-9960x
[Failed] c90d07f7 ursa-thinkcentre-m75q
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

ursabot · 2022-08-24T09:01:56Z

['Python', 'R'] benchmarks have high level of regressions.
ec2-t3-xlarge-us-east-2

PR apache#13781 moved back the testing submodule to an old changeset by mistake, which subsequently broke multiple CI builds. (added a dummy C++ change to trigger CI)

PR #13781 moved back the testing submodule to an old changeset by mistake, which subsequently broke multiple CI builds. (added a dummy C++ change to trigger CI) Authored-by: Antoine Pitrou <[email protected]> Signed-off-by: Antoine Pitrou <[email protected]>

…requests (apache#13781) These changes aim to document the issue lifecycle - how to create new issues (largely already existed) as well as how to engage with and understand issue state later on. This also serves to document proposed processes: 1. Assigned issues idle more than 90 days may be unassigned (discussed and approved on ML) 2. Unassigned issues in "In Progress" status should be set to "Open" 3. Establishing consistent usage of Status and Resolution fields. Authored-by: Todd Farmer <[email protected]> Signed-off-by: Antoine Pitrou <[email protected]>

PR apache#13781 moved back the testing submodule to an old changeset by mistake, which subsequently broke multiple CI builds. (added a dummy C++ change to trigger CI) Authored-by: Antoine Pitrou <[email protected]> Signed-off-by: Antoine Pitrou <[email protected]>

…requests (apache#13781) These changes aim to document the issue lifecycle - how to create new issues (largely already existed) as well as how to engage with and understand issue state later on. This also serves to document proposed processes: 1. Assigned issues idle more than 90 days may be unassigned (discussed and approved on ML) 2. Unassigned issues in "In Progress" status should be set to "Open" 3. Establishing consistent usage of Status and Resolution fields. Authored-by: Todd Farmer <[email protected]> Signed-off-by: Antoine Pitrou <[email protected]>

PR apache#13781 moved back the testing submodule to an old changeset by mistake, which subsequently broke multiple CI builds. (added a dummy C++ change to trigger CI) Authored-by: Antoine Pitrou <[email protected]> Signed-off-by: Antoine Pitrou <[email protected]>

github-actions bot added the Component: Documentation label Aug 2, 2022

toddfarmer commented Aug 2, 2022

View reviewed changes

raulcd reviewed Aug 3, 2022

View reviewed changes

toddfarmer changed the title ~~MINOR: Documenting issue lifecycle for bugs and feature requests~~ ARROW-17322: [Docs] Documenting issue lifecycle for bugs and feature requests Aug 5, 2022

toddfarmer added 2 commits August 5, 2022 10:17

MINOR: Clarifying issue lifecycle

47d95d7

Adding link to dev mailing list, fixing inbound links from other pages

fe5de40

toddfarmer force-pushed the toddfarmer/document-issue-lifecycle branch from dd6d2e0 to fe5de40 Compare August 5, 2022 16:17

kou approved these changes Aug 9, 2022

View reviewed changes

toddfarmer and others added 3 commits August 9, 2022 10:47

Fixing length of header indicator

4374018

Co-authored-by: Sutou Kouhei <[email protected]>

Adding space before link ref

3d29506

Co-authored-by: Sutou Kouhei <[email protected]>

Replace issue "name" with "summary"

438063b

Co-authored-by: Sutou Kouhei <[email protected]>

kou reviewed Aug 10, 2022

View reviewed changes

docs/source/developers/bug_reports.rst Outdated Show resolved Hide resolved

Correct capitalization of "Jira"

1e0b522

Co-authored-by: Sutou Kouhei <[email protected]>

pitrou reviewed Aug 18, 2022

View reviewed changes

Grammar correction

c27ad02

Co-authored-by: Antoine Pitrou <[email protected]>

AlenkaF approved these changes Aug 22, 2022

View reviewed changes

toddfarmer and others added 4 commits August 22, 2022 10:49

Clarifying initial usage of "ASF"

677c3be

Co-authored-by: Antoine Pitrou <[email protected]>

Issue assignment no longer requires contributor role

d9e638f

Co-authored-by: Alenka Frim <[email protected]>

Fixing assignment grammar

2ed7e0c

Fixing volunteer/community per comments, making resolution of Fixed r…

fd84d07

…equired for Resolved status

pitrou approved these changes Aug 24, 2022

View reviewed changes

pitrou merged commit d53bce2 into apache:master Aug 24, 2022

kou mentioned this pull request Aug 24, 2022

ARROW-17433: [CI][C++] Use Visual Studio 2019 on AppVeyor #13903

Merged

pitrou mentioned this pull request Aug 24, 2022

MINOR: [CI][C++] Update testing submodule #13963

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ARROW-17322: [Docs] Documenting issue lifecycle for bugs and feature requests #13781

ARROW-17322: [Docs] Documenting issue lifecycle for bugs and feature requests #13781

toddfarmer commented Aug 2, 2022 •

edited

Loading

toddfarmer Aug 2, 2022 •

edited

Loading

pitrou Aug 23, 2022

toddfarmer Aug 2, 2022

pitrou Aug 23, 2022

toddfarmer commented Aug 2, 2022

raulcd left a comment

raulcd Aug 3, 2022

toddfarmer Aug 3, 2022

kou commented Aug 5, 2022

github-actions bot commented Aug 5, 2022

toddfarmer commented Aug 5, 2022

kou left a comment

kou left a comment

pitrou Aug 18, 2022

toddfarmer Aug 23, 2022

pitrou Aug 23, 2022

toddfarmer Aug 23, 2022

pitrou Aug 24, 2022

AlenkaF left a comment

AlenkaF Aug 22, 2022

toddfarmer Aug 22, 2022

pitrou left a comment

ursabot commented Aug 24, 2022

ursabot commented Aug 24, 2022

	and may be requested by emailing the dev mailing list.
	and may be requested by emailing the `dev@arrow.apache.org <https://mail-archives.apache.org/mod_mbox/arrow-dev/>`_ mailing list.

ARROW-17322: [Docs] Documenting issue lifecycle for bugs and feature requests #13781

ARROW-17322: [Docs] Documenting issue lifecycle for bugs and feature requests #13781

Conversation

toddfarmer commented Aug 2, 2022 • edited Loading

toddfarmer Aug 2, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

toddfarmer commented Aug 2, 2022

raulcd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kou commented Aug 5, 2022

github-actions bot commented Aug 5, 2022

toddfarmer commented Aug 5, 2022

kou left a comment

Choose a reason for hiding this comment

kou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AlenkaF left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pitrou left a comment

Choose a reason for hiding this comment

ursabot commented Aug 24, 2022

ursabot commented Aug 24, 2022

toddfarmer commented Aug 2, 2022 •

edited

Loading

toddfarmer Aug 2, 2022 •

edited

Loading