kyuubi/docs/contributing/code/developer.md
senmiaoliu 564ee509f0
[KYUUBI #5162][DOC] Add statements about contributions co-authored with AIGC in developer guide page
### _Why are the changes needed?_

close #5162

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.readthedocs.io/en/master/contributing/code/testing.html#running-tests) locally before make a pull request

### _Was this patch authored or co-authored using generative AI tooling?_

 No

Closes #5163 from lsm1/features/kyuubi-5162.

Closes #5162

c5bba8c20 [senmiaoliu] fix
af5e816fb [Kent Yao] Update docs/contributing/code/developer.md
ceb44358d [senmiaoliu] Add statements about contributions co-authored with AIGC in developer guide page

Lead-authored-by: senmiaoliu <senmiaoliu@trip.com>
Co-authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-08-16 11:58:39 +08:00

2.6 KiB

Developer Tools

Update Project Version


build/mvn versions:set -DgenerateBackupPoms=false

Update Dependency List

Kyuubi uses the dev/dependencyList file to indicate what upstream dependencies will actually go to the server-side classpath.

For Pull requests, a linter for dependency check will be automatically executed in GitHub Actions.

You can run build/dependency.sh locally first to detect the potential dependency change first.

If the changes look expected, run build/dependency.sh --replace to update dev/dependencyList in your Pull request.

Format All Code

Kyuubi uses Spotless with google-java-format and Scalafmt to format the Java and Scala code.

You can run dev/reformat to format all Java and Scala code.

Append descriptions of new configurations to settings.md

Kyuubi uses settings.md to explain available configurations.

You can run KYUUBI_UPDATE=1 build/mvn clean test -pl kyuubi-server -am -Pflink-provided,spark-provided,hive-provided -DwildcardSuites=org.apache.kyuubi.config.AllKyuubiConfiguration to append descriptions of new configurations to settings.md.

Generative Tooling Usage

In general, the ASF allows contributions co-authored using generative AI tools. However, there are several considerations when you submit a patch containing generated content.

Foremost, you are required to disclose usage of such tool. Furthermore, you are responsible for ensuring that the terms and conditions of the tool in question are compatible with usage in an Open Source project and inclusion of the generated content doesn't pose a risk of copyright violation.

Please refer to The ASF Generative Tooling Guidance for more detailed information.