Document code style #796
Document code style #796
Conversation
|
Please move the section down after Contribution process .. and maybe we want to expand it some more.. I have to look and compare it to the docs in the trino repo .. ideally it could be a complete move but that could happen later |
Chaho12
force-pushed
the
feature/jyoo/document-code-style
branch
from
f703b85 to
e2376dc
Compare
|
Moved it. Sure, just let me know if there are further changes to make. |
development/process.md
Outdated
|
|
||
| All contributions must follow the project's code style guidelines to ensure | ||
| consistency and readability. For Java code, follow the [Trino Java code style guide](https://github.com/trinodb/trino/blob/master/DEVELOPMENT.md#code-style). | ||
| For SQL and documentation, refer to the respective sections in the [development guide](https://github.com/trinodb/trino/blob/master/DEVELOPMENT.md). |
There was a problem hiding this comment.
https://github.com/trinodb/trino/blob/master/DEVELOPMENT.md
The link seems wrong.
There was a problem hiding this comment.
IDK what happened but fixed it. Thx for pointing it out!
Chaho12
force-pushed
the
feature/jyoo/document-code-style
branch
from
e2376dc to
be9b17c
Compare
|
|
||
| All contributions must follow the project's code style guidelines to ensure | ||
| consistency and readability. For Java code, follow the [Trino Java code style guide](https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md#code-style). | ||
| For SQL and documentation, refer to the respective sections in the [development guide](https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md). |
There was a problem hiding this comment.
Where is the style about SQL in this page?
There was a problem hiding this comment.
Did you want to link to https://github.com/trinodb/trino/blob/master/docs/README.md instead?
|
|
||
| All contributions must follow the project's code style guidelines to ensure | ||
| consistency and readability. For Java code, follow the [Trino Java code style guide](https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md#code-style). | ||
| For SQL and documentation, refer to the respective sections in the [development guide](https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md). |
There was a problem hiding this comment.
Did you want to link to https://github.com/trinodb/trino/blob/master/docs/README.md instead?
| consistency and readability. For Java code, follow the [Trino Java code style guide](https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md#code-style). | ||
| For SQL and documentation, refer to the respective sections in the [development guide](https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md). | ||
|
|
||
| Before submitting a pull request, please format your code and check for style issues. |
There was a problem hiding this comment.
Not sure we need this here vs in the process higher up or at all ..
There was a problem hiding this comment.
If we leave .. we should reword to avoid "please" and be direct .. if the code it not formatted it will actually not even pass the build .. you could just say that its a requirement for a PR therefore
Related issue
trinodb/trino#25884
Content
Document code style guide in development/Contribute page
Test
local test
