This is an automated email from the ASF dual-hosted git repository.
jorisvandenbossche pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 910a749f8b GH-14854: Make changes to .md pages (#14852)
910a749f8b is described below
commit 910a749f8b7d15795c153a3ee41013f29b75f605
Author: Alenka Frim <[email protected]>
AuthorDate: Thu Dec 8 12:00:27 2022 +0100
GH-14854: Make changes to .md pages (#14852)
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
cc @ thisisnic
closes https://github.com/apache/arrow/issues/14854
Lead-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Joris Van den Bossche <[email protected]>
Co-authored-by: Nic Crane <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
---
.github/CONTRIBUTING.md | 2 +-
CONTRIBUTING.md | 53 +++++++++++++++++++++----------------------------
README.md | 4 ++--
dev/README.md | 48 +++++++++++++++++++++++++++++++++++++++-----
js/DEVELOP.md | 10 +++++-----
js/README.md | 13 ++++++------
r/README.md | 13 ++++++------
7 files changed, 87 insertions(+), 56 deletions(-)
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index bbabe35857..249f159ec4 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -23,7 +23,7 @@ There are many ways to contribute to Apache Arrow:
* Contributing code (we call them "patches")
* Writing documentation (another form of code, in a way)
-* Participating in discussions on JIRA or the mailing list
+* Participating in discussions on GitHub issues or the mailing list
* Helping users of the libraries
## Reporting bugs and asking questions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 55e9891945..a1c473a24b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -21,42 +21,35 @@
## Did you find a bug?
-The Arrow project uses JIRA as a bug tracker. To report a bug, you'll have
-to first create an account on the
-[Apache Foundation JIRA](https://issues.apache.org/jira/). The JIRA server
-hosts bugs and issues for multiple Apache projects. The JIRA project name
-for Arrow is "ARROW".
-
-To be assigned to an issue, ask an Arrow JIRA admin to go to
-[Arrow
Roles](https://issues.apache.org/jira/plugins/servlet/project-config/ARROW/roles),
-click "Add users to a role," and add you to the "Contributor" role. Most
-committers are authorized to do this; if you're a committer and aren't
-able to load that project admin page, have someone else add you to the
-necessary role.
-
-Before you create a new bug entry, we recommend you first
-[search](https://issues.apache.org/jira/projects/ARROW/issues/ARROW-5140?filter=allopenissues)
-among existing Arrow issues.
-
-When you create a new JIRA entry, please don't forget to fill the "Component"
-field. Arrow has many subcomponents and this helps triaging and filtering
-tremendously. Also, we conventionally prefix the issue title with the
component
-name in brackets, such as "[C++] Crash in Array::Frobnicate()", so as to make
-lists more easy to navigate, and we'd be grateful if you did the same.
+The Arrow project uses GitHub as a bug tracker. To report a bug, sign in to
+your GitHub account, navigate to [GitHub
issues](https://github.com/apache/arrow/issues)
+and click on **New issue** .
+
+To be assigned to an issue, add a comment "take" to that issue.
+
+Before you create a new bug entry, we recommend you first search among existing
+Arrow issues in
+[Jira](https://issues.apache.org/jira/issues/?jql=project%20%3D%20ARROW%20AND%20status%20%3D%20Open)
+or [GitHub](https://github.com/apache/arrow/issues).
+
+We conventionally prefix the issue title with the component
+name in brackets, such as "[C++][Python] Ensure no validity bitmap in
+UnionArray::SetData", so as to make lists more easy to navigate, and
+we'd be grateful if you did the same.
## Did you write a patch that fixes a bug or brings an improvement?
-First create a JIRA entry as described above. Then, submit your changes
-as a GitHub Pull Request. We'll ask you to prefix the pull request title
-with the JIRA issue number and the component name in brackets.
-(for example: "ARROW-2345: [C++] Fix crash in Array::Frobnicate()").
-Respecting this convention makes it easier for us to process the backlog
-of submitted Pull Requests.
+First create a GitHub issue as described above, selecting **Bug Report** or
+**Enhancement Request**. Then, submit your changes as a GitHub Pull Request.
+We'll ask you to prefix the pull request title with the GitHub issue number
+and the component name in brackets. (for example: "GH-14736: [C++][Python]
+Ensure no validity bitmap in UnionArray::SetData"). Respecting this convention
+makes it easier for us to process the backlog of submitted Pull Requests.
### Minor Fixes
-Any functionality change should have a JIRA opened. For minor changes that
-affect documentation, you do not need to open up a JIRA. Instead you can
+Any functionality change should have a GitHub issue opened. For minor changes
that
+affect documentation, you do not need to open up a GitHub issue. Instead you
can
prefix the title of your PR with "MINOR: " if meets the following guidelines:
* Grammar, usage and spelling fixes that affect no more than 2 files
diff --git a/README.md b/README.md
index 7d10b81c6e..9c4c143e6c 100644
--- a/README.md
+++ b/README.md
@@ -93,12 +93,12 @@ integrations in other projects, we'd be happy to have you
involved:
- Join the mailing list: send an email to
[[email protected]][1]. Share your ideas and use cases for the
project.
-- [Follow our activity on JIRA][3]
+- Follow our activity on [GitHub issues][3]
- [Learn the format][2]
- Contribute code to one of the reference implementations
[1]: mailto:[email protected]
[2]: https://github.com/apache/arrow/tree/master/format
-[3]: https://issues.apache.org/jira/browse/ARROW
+[3]: https://github.com/apache/arrow/issues
[4]: https://github.com/apache/arrow
[5]:
https://github.com/apache/arrow/blob/master/docs/source/developers/contributing.rst
diff --git a/dev/README.md b/dev/README.md
index 6b7bc0271f..151f33b384 100644
--- a/dev/README.md
+++ b/dev/README.md
@@ -76,7 +76,7 @@ Type the pull request number (from
https://github.com/apache/arrow/pulls) and hi
title Blah Blah Blah
source repo/branch
target master
-url https://api.github.com/repos/apache/arrow/pulls/X
+url https://api.github.com/apache/arrow/pulls/X
=== JIRA ARROW-#Y ===
Summary Blah Blah Blah
Assignee Name
@@ -84,8 +84,25 @@ Components C++
Status In Progress
URL https://issues.apache.org/jira/browse/ARROW-#Y
-Proceed with merging pull request #3? (y/n):
+Proceed with merging pull request #X? (y/n):
```
+
+```
+=== Pull Request #X ===
+title GH-#Y: [Component] Title
+source repo/branch
+target master
+url https://api.github.com/apache/arrow/pulls/X
+=== GITHUB #Y ===
+Summary [Component] Title
+Assignee Name
+Components Python
+Status open
+URL https://github.com/apache/arrow/issues/Y
+
+Proceed with merging pull request #X? (y/n): y
+```
+
If this looks good, type y and hit enter.
```
Author 1: Name
@@ -93,10 +110,21 @@ Pull request #X merged!
Merge hash: #hash
Would you like to update the associated JIRA? (y/n): y
-Enter comma-separated fix version(s) [9.0.0]:
+Enter comma-separated fix version(s) [11.0.0]:
+```
+
```
-You can just hit enter and the associated JIRA will be resolved
-with the current fix version.
+Author 1: Name
+Pull request #X merged!
+Merge hash: #hash
+
+Would you like to update the associated issue? (y/n): y
+Enter fix version [11.0.0]:
+```
+
+You can just hit enter and the associated JIRA or GitHub issue
+will be resolved with the current fix version.
+
```
Successfully resolved ARROW-#Y!
=== JIRA ARROW-#Y ===
@@ -107,6 +135,16 @@ Status Resolved
URL https://issues.apache.org/jira/browse/ARROW-#Y
```
+```
+Successfully resolved #Y!
+=== GITHUB #Y ===
+Summary [Component] Title
+Assignee Name
+Components Python
+Status closed
+URL https://github.com/apache/arrow/issues/Y```
+```
+
## Verifying Release Candidates
We have provided a script to assist with verifying release candidates on Linux
diff --git a/js/DEVELOP.md b/js/DEVELOP.md
index 06699830b9..d58f666a1e 100644
--- a/js/DEVELOP.md
+++ b/js/DEVELOP.md
@@ -23,21 +23,21 @@ Even if you do not plan to contribute to Apache Arrow
itself or Arrow
integrations in other projects, we'd be happy to have you involved:
* Join the mailing list: send an email to [[email protected]][1].
- Share your ideas and use cases for the project.
-* [Follow our activity on JIRA][3]
+ Share your ideas and use cases for the project
+* Follow our activity on [GitHub issues][3]
* [Learn the format][2]
* Contribute code to one of the reference implementations
We prefer to receive contributions in the form of GitHub pull requests.
Please send pull requests against the [github.com/apache/arrow][4] repository.
-If you are looking for some ideas on what to contribute, check out the [JIRA
+If you are looking for some ideas on what to contribute, check out the [GitHub
issues][3] for the Apache Arrow project. Comment on the issue and/or contact
[[email protected]](http://mail-archives.apache.org/mod_mbox/arrow-dev/)
with your questions and ideas.
If you’d like to report a bug but don’t have time to fix it, you can still post
-it on JIRA, or email the mailing list
+it on GitHub issues, or email the mailing list
[[email protected]](http://mail-archives.apache.org/mod_mbox/arrow-dev/)
# The package.json scripts
@@ -116,5 +116,5 @@ Run `yarn gulp bundle:webpack:analyze` to open [Webpack
Bundle Analyzer](https:/
[1]: mailto:[email protected]
[2]: https://github.com/apache/arrow/tree/master/format
-[3]: https://issues.apache.org/jira/browse/ARROW
+[3]: https://github.com/apache/arrow/issues
[4]: https://github.com/apache/arrow
diff --git a/js/README.md b/js/README.md
index cbf40867e3..ae52535a22 100644
--- a/js/README.md
+++ b/js/README.md
@@ -173,20 +173,21 @@ integrations in other projects, we'd be happy to have you
involved:
* Join the mailing list: send an email to
[[email protected]][1]. Share your ideas and use cases for the
- project.
-* [Follow our activity on JIRA][3]
+ project
+* Follow our activity on [GitHub issues][3]
* [Learn the format][2]
* Contribute code to one of the reference implementations
-We prefer to receive contributions in the form of GitHub pull requests. Please
send pull requests against the [github.com/apache/arrow][4] repository.
+We prefer to receive contributions in the form of GitHub pull requests.
+Please send pull requests against the [github.com/apache/arrow][4] repository.
-If you are looking for some ideas on what to contribute, check out the [JIRA
+If you are looking for some ideas on what to contribute, check out the [GitHub
issues][3] for the Apache Arrow project. Comment on the issue and/or contact
[[email protected]](https://mail-archives.apache.org/mod_mbox/arrow-dev/)
with your questions and ideas.
If you’d like to report a bug but don’t have time to fix it, you can still post
-it on JIRA, or email the mailing list
+it on GitHub issues, or email the mailing list
[[email protected]](https://mail-archives.apache.org/mod_mbox/arrow-dev/)
## Packaging
@@ -250,6 +251,6 @@ Full list of broader Apache Arrow [projects &
organizations](https://arrow.apach
[1]: mailto:[email protected]
[2]: https://github.com/apache/arrow/tree/master/format
-[3]: https://issues.apache.org/jira/browse/ARROW
+[3]: https://github.com/apache/arrow/issues
[4]: https://github.com/apache/arrow
[5]: https://arrow.apache.org/docs/js/
diff --git a/r/README.md b/r/README.md
index ff96dd8cf0..28f9e192f8 100644
--- a/r/README.md
+++ b/r/README.md
@@ -93,13 +93,12 @@ In addition to the official [Arrow R package
documentation](https://arrow.apache
## Getting help
If you encounter a bug, please file an issue with a minimal reproducible
-example on the [Apache Jira issue
-tracker](https://issues.apache.org/jira/projects/ARROW/issues). Create
-an account or log in, then click "Create" to file an issue. Select the
-project "Apache Arrow (ARROW)", select the component "R", and begin
-the issue summary with "[R]" followed by a space. For more
-information, see the "Report bugs and propose features" section of the
-[Contributing to Apache
+example on [GitHub issues](https://github.com/apache/arrow/issues).
+Log in to your GitHub account, click on **New issue** and select the type of
+issue you want to create. Add a meaningful title prefixed with **`[R]`**
+followed by a space, the issue summary and select component **R** from the
+dropdown list. For more information, see the **Report bugs and propose
+features** section of the [Contributing to Apache
Arrow](https://arrow.apache.org/docs/developers/contributing.html) page
in the Arrow developer documentation.
