|
| 1 | +<!--- |
| 2 | + Licensed to the Apache Software Foundation (ASF) under one |
| 3 | + or more contributor license agreements. See the NOTICE file |
| 4 | + distributed with this work for additional information |
| 5 | + regarding copyright ownership. The ASF licenses this file |
| 6 | + to you under the Apache License, Version 2.0 (the |
| 7 | + "License"); you may not use this file except in compliance |
| 8 | + with the License. You may obtain a copy of the License at |
| 9 | +
|
| 10 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +
|
| 12 | + Unless required by applicable law or agreed to in writing, |
| 13 | + software distributed under the License is distributed on an |
| 14 | + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + KIND, either express or implied. See the License for the |
| 16 | + specific language governing permissions and limitations |
| 17 | + under the License. |
| 18 | +--> |
| 19 | + |
| 20 | +# How to contribute to Apache Arrow Java |
| 21 | + |
| 22 | +## Did you find a bug? |
| 23 | + |
| 24 | +The Arrow Java project uses GitHub as a bug tracker. To report a bug, sign in |
| 25 | +to your GitHub account, navigate to [GitHub issues](https://github.com/apache/arrow-java/issues) |
| 26 | +and click on **New issue** . |
| 27 | + |
| 28 | +Before you create a new bug entry, we recommend you first search among |
| 29 | +existing Arrow issues in [GitHub](https://github.com/apache/arrow-java/issues). |
| 30 | + |
| 31 | +## Did you write a patch that fixes a bug or brings an improvement? |
| 32 | + |
| 33 | +Create a GitHub issue and submit your changes as a GitHub Pull Request. |
| 34 | +Please make sure to [reference the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) in your PR description. |
| 35 | + |
| 36 | +### Minor Fixes |
| 37 | + |
| 38 | +Any functionality change should have a GitHub issue opened. For minor changes that |
| 39 | +affect documentation, you do not need to open up a GitHub issue. Instead you can |
| 40 | +prefix the title of your PR with "MINOR: " if it meets one of the following: |
| 41 | + |
| 42 | +* Grammar, usage and spelling fixes that affect no more than 2 files |
| 43 | +* Documentation updates affecting no more than 2 files and not more |
| 44 | + than 500 words. |
| 45 | + |
| 46 | +## Do you want to propose a significant new feature or an important refactoring? |
| 47 | + |
| 48 | +We ask that all discussions about major changes in the codebase happen |
| 49 | +publicly on the [arrow-dev mailing-list](https://mail-archives.apache.org/mod_mbox/arrow-dev/). |
| 50 | + |
| 51 | +## Do you have questions about the source code, the build procedure or the development process? |
| 52 | + |
| 53 | +You can also ask on the mailing-list, see above. |
| 54 | + |
| 55 | +## Further information |
| 56 | + |
| 57 | +Please read our [development documentation](https://arrow.apache.org/docs/developers/index.html) |
| 58 | +or look through the [New Contributor's Guide](https://arrow.apache.org/docs/developers/guide/index.html). |
0 commit comments