You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/12/12 09:02:45 UTC
[GitHub] [arrow] AlenkaF opened a new pull request, #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
AlenkaF opened a new pull request, #14919:
URL: https://github.com/apache/arrow/pull/14919
This PR is part of the work to update the documentation as we are moving from Jira issue tracker to GitHub issues:
https://github.com/apache/arrow/issues/14822
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1047170943
##########
docs/source/developers/bug_reports.rst:
##########
@@ -203,59 +190,24 @@ Identify affected version
+++++++++++++++++++++++++
If you're reporting something that used to work in a previous version
-but doesn't work in the current release, you can add the **Affects version**
-field to identify the earliest known version where the bug is observed.
-For feature requests and other proposals, leave **Affects version** empty as
-it is not applicable.
+but doesn't work in the current release, you add the **Affects version**
+in the description to identify the earliest known version where the bug is
+observed.
.. _issue-lifecycle:
Issue lifecycle
===============
-Both bug reports and feature requests follow a defined lifecycle. The issue
-**Status** field is used to document the current state of the issue, while the
-**Resolution** field indicates the outcome of issues that have reached
-terminal status.
-
-
-.. _issue-status:
-
-Issue Status
-++++++++++++
-
-The Arrow project uses the following statuses in Jira to indicate what has -
-and will be - done on an issue:
-
-* **Open** - This is the initial issue state, prior to a contributor assigning
- 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
- set back to a status of Open. Issues remain "in progress" until resolved or
- 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
- should have a resolution code set to **Fixed**.
-* **Closed** - Another terminal status, Closed indicates the issue is complete,
- but *without* action being taken. The following resolution codes apply to
- issues in Closed status:
-
- * Won't Fix
- * Duplicate
- * Invalid
- * Incomplete
- * Cannot Reproduce
- * Not a Problem
- * Not a Bug
- * Workaround
- * Information Provided
- * Works for Me
- * Won't Do
- * Abandoned
-
-* **Reopened** - When an issue has been closed or resolved, but additional
- attention is needed, it may be reopened.
+Both bug reports and feature requests follow a defined lifecycle. If the issue
+is currently worked on it has a developer assigned. When the issue has reached
+a terminal status, it is labeled as closed.
+
+* **Closed as completed** - indicates the issue is complete and the PR that
+ resolved the issue should be added in a following comment.
+
+* **closed as not planned** - indicates the issue is complete,
+ but *without* action being taken.
Review Comment:
> But personally I do think such comments are useful, since the autolinking by GitHub itself doesn't generate notifications.
Just to be clear, do you manually add a comment ([example](https://github.com/apache/arrow/issues/14854#issuecomment-1342535500)) when closing an issue? If yes, then I would add this in the docs also.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1046077411
##########
docs/source/developers/bug_reports.rst:
##########
@@ -203,59 +190,24 @@ Identify affected version
+++++++++++++++++++++++++
If you're reporting something that used to work in a previous version
-but doesn't work in the current release, you can add the **Affects version**
-field to identify the earliest known version where the bug is observed.
-For feature requests and other proposals, leave **Affects version** empty as
-it is not applicable.
+but doesn't work in the current release, you add the **Affects version**
+in the description to identify the earliest known version where the bug is
+observed.
Review Comment:
Agree, will remove 👍
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1055310109
##########
docs/source/developers/bug_reports.rst:
##########
@@ -203,59 +190,24 @@ Identify affected version
+++++++++++++++++++++++++
If you're reporting something that used to work in a previous version
-but doesn't work in the current release, you can add the **Affects version**
-field to identify the earliest known version where the bug is observed.
-For feature requests and other proposals, leave **Affects version** empty as
-it is not applicable.
+but doesn't work in the current release, you add the **Affects version**
+in the description to identify the earliest known version where the bug is
+observed.
.. _issue-lifecycle:
Issue lifecycle
===============
-Both bug reports and feature requests follow a defined lifecycle. The issue
-**Status** field is used to document the current state of the issue, while the
-**Resolution** field indicates the outcome of issues that have reached
-terminal status.
-
-
-.. _issue-status:
-
-Issue Status
-++++++++++++
-
-The Arrow project uses the following statuses in Jira to indicate what has -
-and will be - done on an issue:
-
-* **Open** - This is the initial issue state, prior to a contributor assigning
- 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
- set back to a status of Open. Issues remain "in progress" until resolved or
- 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
- should have a resolution code set to **Fixed**.
-* **Closed** - Another terminal status, Closed indicates the issue is complete,
- but *without* action being taken. The following resolution codes apply to
- issues in Closed status:
-
- * Won't Fix
- * Duplicate
- * Invalid
- * Incomplete
- * Cannot Reproduce
- * Not a Problem
- * Not a Bug
- * Workaround
- * Information Provided
- * Works for Me
- * Won't Do
- * Abandoned
-
-* **Reopened** - When an issue has been closed or resolved, but additional
- attention is needed, it may be reopened.
+Both bug reports and feature requests follow a defined lifecycle. If the issue
+is currently worked on it has a developer assigned. When the issue has reached
+a terminal status, it is labeled as closed.
+
+* **Closed as completed** - indicates the issue is complete and the PR that
+ resolved the issue should be added in a following comment.
+
+* **closed as not planned** - indicates the issue is complete,
+ but *without* action being taken.
Review Comment:
Added proposed changes and extra sentence about why it would be nice to add a comment that the issue was closed:
https://github.com/apache/arrow/pull/14919/commits/837c7d98e91259981c510d7e165e61248ce75e83
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
jorisvandenbossche commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1046859113
##########
docs/source/developers/overview.rst:
##########
@@ -97,9 +97,9 @@ Pull request and review
When contributing a patch, use this list as a checklist of Apache Arrow workflow:
* Submit the patch as a **GitHub pull request** against the **master branch**.
-* So that your pull request syncs with the JIRA issue, **prefix your pull request
- name with the JIRA issue id** (ex:
- `ARROW-767: [C++] Filesystem abstraction <https://github.com/apache/arrow/pull/4225>`_).
+* So that your pull request syncs with the GitHub issue, **prefix your pull request
+ title with the GitHub issue id** (ex:
+ `GH-14866: [C++] Remove internal GroupBy implementation <https://github.com/apache/arrow/pull/14867>`_).
Review Comment:
Should we keep both examples of prefixing with github issue id or JIRA number? Since until JIRAs are migrated, PRs will be opened targetting both github and jira issues
##########
docs/source/developers/bug_reports.rst:
##########
@@ -186,8 +173,8 @@ Arrow is an expansive project supporting many languages and organized into a
number of components. Identifying the affected component(s) helps new issues
get attention from appropriate contributors.
-* Use the **Component** field to indicate the area of the project that your
- issue pertains to (for example "Python" or "C++").
+* Use a **Component** label to indicate the area of the project that your
+ issue pertains to (for example "Component: Python" or "Component: C++").
Review Comment:
It's certainly useful to document this (also for committers), but at the same time the wording above is not directly applicable in general for people opening issues, as they can't "use" (add) a label to issues themselves.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot commented on pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
ursabot commented on PR #14919:
URL: https://github.com/apache/arrow/pull/14919#issuecomment-1363407129
Benchmark runs are scheduled for baseline = b48a230e7ef1fa9643d11d978e80816c0af45c87 and contender = 053080dcfeead3565fbe12cfa8a21724c1b0b13d. 053080dcfeead3565fbe12cfa8a21724c1b0b13d is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/36db17bd93e946098d0d2ab1aaa65a02...03ffe17a909548d58c06f4fefc8cca22/)
[Failed] [test-mac-arm](https://conbench.ursa.dev/compare/runs/3d856f7e6813458f813f10f4f53cfc95...5b86e135148d4a84899ff53609f4cf9c/)
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/9cb101a4f9be4361a56eb53b637f3a11...31202aba2a124ae69f900daf6c26ae01/)
[Finished :arrow_down:0.21% :arrow_up:0.03%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/04c409c5555c4a3192e69ce697cf403e...eba457dc27b445d6b4eca9b2303351bc/)
Buildkite builds:
[Finished] [`053080dc` ec2-t3-xlarge-us-east-2](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/2054)
[Failed] [`053080dc` test-mac-arm](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/2076)
[Finished] [`053080dc` ursa-i9-9960x](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/2048)
[Finished] [`053080dc` ursa-thinkcentre-m75q](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/2068)
[Finished] [`b48a230e` ec2-t3-xlarge-us-east-2](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/2053)
[Failed] [`b48a230e` test-mac-arm](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/2075)
[Finished] [`b48a230e` ursa-i9-9960x](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/2047)
[Finished] [`b48a230e` ursa-thinkcentre-m75q](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/2067)
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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
pitrou commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1046080717
##########
docs/source/developers/overview.rst:
##########
@@ -97,9 +97,9 @@ Pull request and review
When contributing a patch, use this list as a checklist of Apache Arrow workflow:
* Submit the patch as a **GitHub pull request** against the **master branch**.
-* So that your pull request syncs with the JIRA issue, **prefix your pull request
- name with the JIRA issue id** (ex:
- `ARROW-767: [C++] Filesystem abstraction <https://github.com/apache/arrow/pull/4225>`_).
+* So that your pull request syncs with the GitHub issue, **prefix your pull request
+ name with the GitHub issue id** (ex:
Review Comment:
```suggestion
title with the GitHub issue id** (ex:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
pitrou commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1046085635
##########
docs/source/developers/bug_reports.rst:
##########
@@ -203,59 +190,24 @@ Identify affected version
+++++++++++++++++++++++++
If you're reporting something that used to work in a previous version
-but doesn't work in the current release, you can add the **Affects version**
-field to identify the earliest known version where the bug is observed.
-For feature requests and other proposals, leave **Affects version** empty as
-it is not applicable.
+but doesn't work in the current release, you add the **Affects version**
+in the description to identify the earliest known version where the bug is
+observed.
.. _issue-lifecycle:
Issue lifecycle
===============
-Both bug reports and feature requests follow a defined lifecycle. The issue
-**Status** field is used to document the current state of the issue, while the
-**Resolution** field indicates the outcome of issues that have reached
-terminal status.
-
-
-.. _issue-status:
-
-Issue Status
-++++++++++++
-
-The Arrow project uses the following statuses in Jira to indicate what has -
-and will be - done on an issue:
-
-* **Open** - This is the initial issue state, prior to a contributor assigning
- 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
- set back to a status of Open. Issues remain "in progress" until resolved or
- 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
- should have a resolution code set to **Fixed**.
-* **Closed** - Another terminal status, Closed indicates the issue is complete,
- but *without* action being taken. The following resolution codes apply to
- issues in Closed status:
-
- * Won't Fix
- * Duplicate
- * Invalid
- * Incomplete
- * Cannot Reproduce
- * Not a Problem
- * Not a Bug
- * Workaround
- * Information Provided
- * Works for Me
- * Won't Do
- * Abandoned
-
-* **Reopened** - When an issue has been closed or resolved, but additional
- attention is needed, it may be reopened.
+Both bug reports and feature requests follow a defined lifecycle. If the issue
+is currently worked on it has a developer assigned. When the issue has reached
+a terminal status, it is labeled as closed.
+
+* **Closed as completed** - indicates the issue is complete and the PR that
+ resolved the issue should be added in a following comment.
+
+* **closed as not planned** - indicates the issue is complete,
+ but *without* action being taken.
Review Comment:
Here is a suggestion to rephrase this (note that GitHub auto-links PRs to their corresponding issues, so I'm not sure you need to add an issue comment to mention a PR?):
```suggestion
Both bug reports and feature requests follow a defined lifecycle. If an issue
is currently worked on, it should have a developer assigned. When an issue has
reached a terminal status, it is closed with one of two outcomes:
* **Closed as completed** - indicates the issue is complete; the PR that
resolved the issue should have been automatically linked by GitHub
(assuming the PR correctly mentioned the issue number).
* **closed as not planned** - indicates the issue is closed and should
not receive any further updates, but *without* action being taken.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
pitrou commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1046080298
##########
docs/source/developers/overview.rst:
##########
@@ -33,7 +33,7 @@ checklist for using ``git``:
"upstream".
* Keep your fork's **master branch synced** with ``upstream/master``.
* **Develop on branches**, rather than your own "master" branch.
-* It does not matter what you call your branch. Some people like to use the JIRA
+* It does not matter what you call your branch. Some people like to use the GitHub
number as branch name, others use descriptive names.
Review Comment:
```suggestion
issue number as branch name, others use descriptive names.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
pitrou commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1046072254
##########
docs/source/developers/bug_reports.rst:
##########
@@ -203,59 +190,24 @@ Identify affected version
+++++++++++++++++++++++++
If you're reporting something that used to work in a previous version
-but doesn't work in the current release, you can add the **Affects version**
-field to identify the earliest known version where the bug is observed.
-For feature requests and other proposals, leave **Affects version** empty as
-it is not applicable.
+but doesn't work in the current release, you add the **Affects version**
+in the description to identify the earliest known version where the bug is
+observed.
Review Comment:
I'm not sure it makes sense to keep this paragraph. People will generally mention that it's a regression in order to get attention.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
pitrou commented on PR #14919:
URL: https://github.com/apache/arrow/pull/14919#issuecomment-1346860867
@jorisvandenbossche Do you want to comment on this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #14919:
URL: https://github.com/apache/arrow/pull/14919#issuecomment-1346121328
:warning: GitHub issue #14918 **has been automatically assigned in GitHub** to PR creator.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1046831412
##########
docs/source/developers/bug_reports.rst:
##########
@@ -203,59 +190,24 @@ Identify affected version
+++++++++++++++++++++++++
If you're reporting something that used to work in a previous version
-but doesn't work in the current release, you can add the **Affects version**
-field to identify the earliest known version where the bug is observed.
-For feature requests and other proposals, leave **Affects version** empty as
-it is not applicable.
+but doesn't work in the current release, you add the **Affects version**
+in the description to identify the earliest known version where the bug is
+observed.
.. _issue-lifecycle:
Issue lifecycle
===============
-Both bug reports and feature requests follow a defined lifecycle. The issue
-**Status** field is used to document the current state of the issue, while the
-**Resolution** field indicates the outcome of issues that have reached
-terminal status.
-
-
-.. _issue-status:
-
-Issue Status
-++++++++++++
-
-The Arrow project uses the following statuses in Jira to indicate what has -
-and will be - done on an issue:
-
-* **Open** - This is the initial issue state, prior to a contributor assigning
- 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
- set back to a status of Open. Issues remain "in progress" until resolved or
- 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
- should have a resolution code set to **Fixed**.
-* **Closed** - Another terminal status, Closed indicates the issue is complete,
- but *without* action being taken. The following resolution codes apply to
- issues in Closed status:
-
- * Won't Fix
- * Duplicate
- * Invalid
- * Incomplete
- * Cannot Reproduce
- * Not a Problem
- * Not a Bug
- * Workaround
- * Information Provided
- * Works for Me
- * Won't Do
- * Abandoned
-
-* **Reopened** - When an issue has been closed or resolved, but additional
- attention is needed, it may be reopened.
+Both bug reports and feature requests follow a defined lifecycle. If the issue
+is currently worked on it has a developer assigned. When the issue has reached
+a terminal status, it is labeled as closed.
+
+* **Closed as completed** - indicates the issue is complete and the PR that
+ resolved the issue should be added in a following comment.
+
+* **closed as not planned** - indicates the issue is complete,
+ but *without* action being taken.
Review Comment:
Oh yeah, of course. What I meant was that the link should be done automatically and it should be visible as a comment in the GitHub issue for the user to see.
I will change the text with what you have suggested as it is much clearer, thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1047123596
##########
docs/source/developers/bug_reports.rst:
##########
@@ -186,8 +173,8 @@ Arrow is an expansive project supporting many languages and organized into a
number of components. Identifying the affected component(s) helps new issues
get attention from appropriate contributors.
-* Use the **Component** field to indicate the area of the project that your
- issue pertains to (for example "Python" or "C++").
+* Use a **Component** label to indicate the area of the project that your
+ issue pertains to (for example "Component: Python" or "Component: C++").
Review Comment:
Ah, I thought anybody can select the component from the label list. In that case we can write something like: "Component label, which can be added by a committer of the Apache Arrow project, is used to indicate the area of the project that your issue pertains to ..."
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1047124080
##########
docs/source/developers/overview.rst:
##########
@@ -97,9 +97,9 @@ Pull request and review
When contributing a patch, use this list as a checklist of Apache Arrow workflow:
* Submit the patch as a **GitHub pull request** against the **master branch**.
-* So that your pull request syncs with the JIRA issue, **prefix your pull request
- name with the JIRA issue id** (ex:
- `ARROW-767: [C++] Filesystem abstraction <https://github.com/apache/arrow/pull/4225>`_).
+* So that your pull request syncs with the GitHub issue, **prefix your pull request
+ title with the GitHub issue id** (ex:
+ `GH-14866: [C++] Remove internal GroupBy implementation <https://github.com/apache/arrow/pull/14867>`_).
Review Comment:
Can do 👍
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
jorisvandenbossche commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1046852082
##########
docs/source/developers/bug_reports.rst:
##########
@@ -203,59 +190,24 @@ Identify affected version
+++++++++++++++++++++++++
If you're reporting something that used to work in a previous version
-but doesn't work in the current release, you can add the **Affects version**
-field to identify the earliest known version where the bug is observed.
-For feature requests and other proposals, leave **Affects version** empty as
-it is not applicable.
+but doesn't work in the current release, you add the **Affects version**
+in the description to identify the earliest known version where the bug is
+observed.
.. _issue-lifecycle:
Issue lifecycle
===============
-Both bug reports and feature requests follow a defined lifecycle. The issue
-**Status** field is used to document the current state of the issue, while the
-**Resolution** field indicates the outcome of issues that have reached
-terminal status.
-
-
-.. _issue-status:
-
-Issue Status
-++++++++++++
-
-The Arrow project uses the following statuses in Jira to indicate what has -
-and will be - done on an issue:
-
-* **Open** - This is the initial issue state, prior to a contributor assigning
- 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
- set back to a status of Open. Issues remain "in progress" until resolved or
- 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
- should have a resolution code set to **Fixed**.
-* **Closed** - Another terminal status, Closed indicates the issue is complete,
- but *without* action being taken. The following resolution codes apply to
- issues in Closed status:
-
- * Won't Fix
- * Duplicate
- * Invalid
- * Incomplete
- * Cannot Reproduce
- * Not a Problem
- * Not a Bug
- * Workaround
- * Information Provided
- * Works for Me
- * Won't Do
- * Abandoned
-
-* **Reopened** - When an issue has been closed or resolved, but additional
- attention is needed, it may be reopened.
+Both bug reports and feature requests follow a defined lifecycle. If the issue
+is currently worked on it has a developer assigned. When the issue has reached
+a terminal status, it is labeled as closed.
+
+* **Closed as completed** - indicates the issue is complete and the PR that
+ resolved the issue should be added in a following comment.
+
+* **closed as not planned** - indicates the issue is complete,
+ but *without* action being taken.
Review Comment:
> note that GitHub auto-links PRs to their corresponding issues, so I'm not sure you need to add an issue comment to mention a PR?
We indeed don't need to mention that, since the automation of the script will add this comment to say the issue was closed (so you don't have to do this manually). But personally I do think such comments are useful, since the autolinking by GitHub itself doesn't generate notifications.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a diff in pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
pitrou commented on code in PR #14919:
URL: https://github.com/apache/arrow/pull/14919#discussion_r1046070524
##########
docs/source/developers/bug_reports.rst:
##########
@@ -186,7 +173,7 @@ Arrow is an expansive project supporting many languages and organized into a
number of components. Identifying the affected component(s) helps new issues
get attention from appropriate contributors.
-* Use the **Component** field to indicate the area of the project that your
+* Use the **Component** label to indicate the area of the project that your
issue pertains to (for example "Python" or "C++").
Review Comment:
```suggestion
issue pertains to (for example "Component: Python" or "Component: C++").
```
##########
docs/source/developers/bug_reports.rst:
##########
@@ -186,7 +173,7 @@ Arrow is an expansive project supporting many languages and organized into a
number of components. Identifying the affected component(s) helps new issues
get attention from appropriate contributors.
-* Use the **Component** field to indicate the area of the project that your
+* Use the **Component** label to indicate the area of the project that your
Review Comment:
```suggestion
* Use a **Component** label to indicate the area of the project that your
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] jorisvandenbossche merged pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
jorisvandenbossche merged PR #14919:
URL: https://github.com/apache/arrow/pull/14919
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot commented on pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
ursabot commented on PR #14919:
URL: https://github.com/apache/arrow/pull/14919#issuecomment-1363407265
['Python', 'R'] benchmarks have high level of regressions.
[ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/9cb101a4f9be4361a56eb53b637f3a11...31202aba2a124ae69f900daf6c26ae01/)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #14919: GH-14918: [Docs] Make changes to developers section of the docs (Jira -> GitHub)
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #14919:
URL: https://github.com/apache/arrow/pull/14919#issuecomment-1346121256
* Closes: #14918
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org