Skip to content

Commit

Permalink
apacheGH-14854: Make changes to .md pages (apache#14852)
Browse files Browse the repository at this point in the history
This PR is part of the work to update the documentation as we are moving from Jira issue tracker to GitHub issues:
apache#14822

cc @ thisisnic 

closes apache#14854

Lead-authored-by: Alenka Frim <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Co-authored-by: Nic Crane <thisisnic@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
  • Loading branch information
3 people authored Dec 8, 2022
1 parent 26a426f commit 910a749
Show file tree
Hide file tree
Showing 7 changed files with 87 additions and 56 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
53 changes: 23 additions & 30 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,12 @@ integrations in other projects, we'd be happy to have you involved:
- Join the mailing list: send an email to
[dev-subscribe@arrow.apache.org][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:dev-subscribe@arrow.apache.org
[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
48 changes: 43 additions & 5 deletions dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,27 +76,55 @@ 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
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
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 ===
Expand All @@ -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
Expand Down
10 changes: 5 additions & 5 deletions js/DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [dev-subscribe@arrow.apache.org][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
[dev@arrow.apache.org](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
[dev@arrow.apache.org](http://mail-archives.apache.org/mod_mbox/arrow-dev/)

# The package.json scripts
Expand Down Expand Up @@ -116,5 +116,5 @@ Run `yarn gulp bundle:webpack:analyze` to open [Webpack Bundle Analyzer](https:/
[1]: mailto:dev-subscribe@arrow.apache.org
[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
13 changes: 7 additions & 6 deletions js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,20 +173,21 @@ integrations in other projects, we'd be happy to have you involved:

* Join the mailing list: send an email to
[dev-subscribe@arrow.apache.org][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
[dev@arrow.apache.org](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
[dev@arrow.apache.org](https://mail-archives.apache.org/mod_mbox/arrow-dev/)

## Packaging
Expand Down Expand Up @@ -250,6 +251,6 @@ Full list of broader Apache Arrow [projects & organizations](https://arrow.apach

[1]: mailto:dev-subscribe@arrow.apache.org
[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/
13 changes: 6 additions & 7 deletions r/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 910a749

Please sign in to comment.