Skip to content

Commit e2376dc

Browse files
author
Jaeho Yoo
committed
Document code style
1 parent 1e6fa1e commit e2376dc

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

development/process.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ show_hero: true
77
show_pagenav: true
88
---
99

10-
1110
<div class="container container__development">
1211

1312
<div class="row spacer-60">
@@ -20,7 +19,7 @@ following sections:
2019

2120
## Contribution process
2221

23-
This is the process we suggest for contributions. This process is designed to
22+
This is the process we suggest for contributions. This process is designed to
2423
reduce the burden on project reviewers, impact on other contributors, and to
2524
keep the amount of rework from the contributor to a minimum.
2625

@@ -58,7 +57,7 @@ keep the amount of rework from the contributor to a minimum.
5857
1. If you already have a `[WIP]` or draft PR, change it to ready for review.
5958
2. Refer to the [GitHub documentation for more details about collaborating with PRs](https://docs.github.com/en/pull-requests).
6059
3. Make sure the pull request passes the tests in CI.
61-
2. If known, request a review from an expert in the area changed. If
60+
4. If known, request a review from an expert in the area changed. If
6261
unknown, ask for help on [Slack](/slack.html).
6362

6463
There are some tests that use external services, like Google BigQuery, and
@@ -102,12 +101,21 @@ keep the amount of rework from the contributor to a minimum.
102101
website are updated.
103102
* Finally the release is announced.
104103

104+
## Code style
105+
106+
All contributions must follow the project's code style guidelines to ensure
107+
consistency and readability. For Java code, follow the [Trino Java code style guide](https://github.com/trinodb/trino/blob/master/DEVELOPMENT.md#code-style).
108+
For SQL and documentation, refer to the respective sections in the [development guide](https://github.com/trinodb/trino/blob/master/DEVELOPMENT.md).
109+
110+
Before submitting a pull request, please format your code and check for style issues.
111+
Consistent code style helps reviewers and maintainers focus on the logic and quality of your contribution.
112+
105113
## Pull request and commit guidelines <a name="commit"></a>
106114

107115
Contributions to Trino projects are managed as [collaboration with pull
108116
requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests).
109117

110-
Pull requests are usually merged into `master` or `main` using the [`rebase and
118+
Pull requests are usually merged into `master` or `main` using the [`rebase and
111119
merge`](https://docs.github.com/en/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-pull-request-commits)
112120
strategy to preserve the commits from the contributor and avoid adding empty
113121
merge commits.
@@ -186,7 +194,7 @@ In each section different release notes entries are sorted:
186194
1. **New features**: Start with `Add` or `Add support for` or similar wording
187195
2. **Performance improvements**: Start with `Improve` or `Improve performance`
188196
or similar wording
189-
3. **Bug fixes**: Start with `Fix` or `Prevent` or similar wording
197+
3. **Bug fixes**: Start with `Fix` or `Prevent` or similar wording
190198

191199
Use [imperative present tense, as used in a command or
192200
request](https://en.wikipedia.org/wiki/Imperative_mood) to describe the change.
@@ -205,7 +213,7 @@ especially if more information is needed.
205213

206214
Release notes entries that prevent application start up with old configuration
207215
or otherwise change application behavior significantly must be marked as
208-
breaking changes.
216+
breaking changes.
209217

210218
The specific syntax for the release notes, breaking changes, links and other
211219
aspects, is dependent on the used documentation system for each project. For
@@ -248,7 +256,7 @@ The following aspects apply for reviewing pull requests.
248256
understand and assess the security implications of running the test suite on
249257
the external service and ensure that no malicious code is run.
250258

251-
### Pull request review and merge
259+
### Pull request review and merge
252260

253261
The following criteria and aspects apply for merging pull requests.
254262

0 commit comments

Comments
 (0)