Skip to content

Commit 38e9682

Browse files
committed
chore: Add CONTRIBUTING.md
1 parent 024ce73 commit 38e9682

File tree

1 file changed

+118
-0
lines changed

1 file changed

+118
-0
lines changed

CONTRIBUTING.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
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 Swift
21+
22+
We utilize [Conventional
23+
Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our
24+
commit messages. This helps maintain the semantic versioning of this
25+
module.
26+
27+
Please use the following commit types: `chore`, `feat`, `fix`.
28+
29+
If a PR includes any breaking change, please add `!` such as `feat!`
30+
and `fix!`.
31+
32+
We will use these commit types to determine the next version. If we
33+
have only `fix` (and `chore`) changes, we will increase the patch
34+
version. If we have any `feat` change, we will increase the minor
35+
version. If we have any `feat!` or `fix!` change, we will increase the
36+
major version.
37+
38+
For example:
39+
40+
```
41+
fix: Handle empty structs in C data interface
42+
43+
fix!: Fix performance regression with API change
44+
45+
chore: Update CI environment
46+
47+
feat: Support new encoding type
48+
49+
feat!: Reconstruct API
50+
```
51+
52+
## Did you find a bug?
53+
54+
The Arrow Swift project uses GitHub as a bug tracker. To report a bug,
55+
sign in to your GitHub account, navigate to [GitHub
56+
issues](https://github.com/apache/arrow-swift/issues) and click on
57+
**New issue** .
58+
59+
Before you create a new bug entry, we recommend you first search among
60+
existing issues in
61+
[GitHub](https://github.com/apache/arrow-swift/issues).
62+
63+
## Did you write a patch that fixes a bug or brings an improvement?
64+
65+
- Create a GitHub issue and submit your changes as a GitHub Pull Request.
66+
- [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.
67+
- Add the PR title. The PR title will be used as the eventual commit message, so please make it descriptive but succinct.
68+
69+
Example #1:
70+
71+
```
72+
Document the pull request process
73+
74+
Explain how to open a pull request and what the title, body, and labels should be.
75+
76+
Closes #12345.
77+
```
78+
79+
Example #2:
80+
81+
```
82+
Expose Netty server builder in Flight
83+
84+
Allow direct usage of gRPC APIs for low-level control.
85+
86+
Closes #42424.
87+
```
88+
89+
### Minor fixes
90+
91+
Any functionality change should have a GitHub issue opened. For minor
92+
changes that affect documentation, you do not need to open up a GitHub
93+
issue. If your changes meet one of the following, they're minor
94+
changes:
95+
96+
* Grammar, usage and spelling fixes that affect no more than 2 files
97+
* Documentation updates affecting no more than 2 files and not more
98+
than 500 words.
99+
100+
## Do you want to propose a significant new feature or an important refactoring?
101+
102+
We ask that all discussions about major changes in the codebase happen
103+
publicly on the GitHub issues or [arrow-dev
104+
mailing-list](https://lists.apache.org/[email protected]).
105+
106+
## Do you have questions about the source code, the build procedure or the development process?
107+
108+
You can also ask on the [arrow-dev
109+
mailing-list](https://lists.apache.org/[email protected])
110+
or [GitHub
111+
Discussions](https://github.com/apache/arrow-swift/discussions).
112+
113+
## Further information
114+
115+
Please read our [development
116+
documentation](https://arrow.apache.org/docs/developers/index.html) or
117+
look through the [New Contributor's
118+
Guide](https://arrow.apache.org/docs/developers/guide/index.html).

0 commit comments

Comments
 (0)