You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+50-22Lines changed: 50 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,32 +64,60 @@ Before starting on a large code change, please describe the concept/design of wh
64
64
65
65
The best way to provide changes is to fork Apache Polaris repository on GitHub and provide a Pull Request with your changes. To make it easy to apply your changes please use the following conventions:
66
66
67
-
* Every Pull Request should have a matching GitHub Issue.
* Work on the changes of your pull requests locally.
79
+
* Ensure the code is properly formatted:
80
+
```bash
81
+
./gradlew format
82
+
```
83
+
* Ensure the code is passing the tests:
84
+
```bash
85
+
./gradlew check
86
+
```
87
+
* You may want to push your changes to your personal Polaris fork. Git will emit a URL that you can use to create the pull request. Do not create the pull request yet.
88
+
```bash
89
+
git push --set-upstream your-github-accout
90
+
```
91
+
92
+
#### Opening a pull request
93
+
94
+
* Before opening a pull request, squash all commits in your branch into a single commit
95
+
* Update the subject and message of the commit to match the summary and description of the latter pull-request, GitHub will populate the PR summary and description from the "single" commit.
96
+
* Make sure that the summary reflects the targeted area of the code base, for example `docs` or `CI`. Get inspired by [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
97
+
* The PR description should describe the background of the change and a description of the changes in way that someone who has no prior knowledge can understand the rationale of the change and the change itself.
98
+
* If there is a matching GitHub Issue, add a separate line at the end of the commit message of the issue that the PR fixes. Do not add the issue number into the subject.
99
+
```
100
+
Fixes #123456
101
+
```
102
+
If the PR does not fully fix the issue, use `Related to #123456` instead of `Fixes #123456`.
103
+
* When opening a PR consider whether the PR is "draft" or already "ready for review". "Draft" means work in progress, things will change, but comments are welcome. "Ready for review" means that the PR is requested to be merged as is (pending review feedback).
104
+
105
+
#### Working on a pull request
106
+
107
+
* Don't forget to periodically rebase your branch:
108
+
```bash
109
+
git pull --rebase
110
+
git push your-github-accout my-branch --force
111
+
```
91
112
* Test that your changes works by adapting or adding tests. Verify the build passes (see `README.md` for build instructions).
92
113
* If your Pull Request has conflicts with the `main` branch, please rebase and fix the conflicts.
114
+
* If your PR requires more work or time or bigger changes, please put the PR to "draft" state to indicate that it is not meant to be "thoroughly" reviewed at this point.
115
+
116
+
#### Merging a pull request
117
+
118
+
* When a PR is about to be merged, cross-check the commit summary and message for the merged Git commit.
119
+
* Keep in mind that the Git commit subject and message is going to be read by other people, potentially even after years. The Git commit subject and message will appear "as is" in release notes.
120
+
* Make sure the subject and message are properly formatted and contains a concise description of the changes in way that someone who has no prior knowledge can understand the rationale of the change and the change itself. Remove information that's of no use for someone reading the Git commit log, for example single intermediate commit messages like `formatting` or `fix test`.
0 commit comments