Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Developer guide update with Spotless details #2000

Merged

Conversation

MitchellGale
Copy link
Contributor

Description

Adds more information and links about spotless and google java formatter in the developer guide.

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

DEVELOPER_GUIDE.rst Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.rst Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.rst Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.rst Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 21, 2023

Codecov Report

Merging #2000 (fd7acff) into main (ac9b5d8) will decrease coverage by 0.04%.
Report is 4 commits behind head on main.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #2000      +/-   ##
============================================
- Coverage     97.33%   97.30%   -0.04%     
+ Complexity     4657     4621      -36     
============================================
  Files           408      407       -1     
  Lines         12097    11933     -164     
  Branches        829      826       -3     
============================================
- Hits          11775    11611     -164     
  Misses          315      315              
  Partials          7        7              
Flag Coverage Δ
sql-engine 97.30% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 22 files with indirect coverage changes

Signed-off-by: Mitchell Gale <[email protected]>
DEVELOPER_GUIDE.rst Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.rst Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.rst Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.rst Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.rst Outdated Show resolved Hide resolved
MitchellGale and others added 3 commits August 21, 2023 14:03
Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>
Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>
Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>
MitchellGale and others added 3 commits August 21, 2023 14:04
Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>
Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>
@acarbonetto acarbonetto merged commit 8f650e8 into opensearch-project:main Aug 21, 2023
21 of 22 checks passed
@acarbonetto acarbonetto deleted the integ/UpdateDevDocs_Spotless branch August 21, 2023 22:28
opensearch-trigger-bot bot pushed a commit that referenced this pull request Aug 21, 2023
* Added spotless java format rules to dev guide

Signed-off-by: Mitchell Gale <[email protected]>

* Fixed formatting of URLS in DEVELOPER_GUIDE.rst

Signed-off-by: Mitchell Gale <[email protected]>

* addressed PR comments

Signed-off-by: Mitchell Gale <[email protected]>

* addressed PR comments

Signed-off-by: Mitchell Gale <[email protected]>

* addressed PR comments

Signed-off-by: Mitchell Gale <[email protected]>

* Update DEVELOPER_GUIDE.rst

Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>

* Update DEVELOPER_GUIDE.rst

Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>

* Update DEVELOPER_GUIDE.rst

Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>

* Update DEVELOPER_GUIDE.rst

Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>

* Update DEVELOPER_GUIDE.rst

Co-authored-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>

* fixed link format

Signed-off-by: Mitchell Gale <[email protected]>

---------

Signed-off-by: Mitchell Gale <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>
Co-authored-by: Yury-Fridlyand <[email protected]>
(cherry picked from commit 8f650e8)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
acarbonetto pushed a commit that referenced this pull request Aug 21, 2023
* Added spotless java format rules to dev guide



* Fixed formatting of URLS in DEVELOPER_GUIDE.rst



* addressed PR comments



* addressed PR comments



* addressed PR comments



* Update DEVELOPER_GUIDE.rst




* Update DEVELOPER_GUIDE.rst




* Update DEVELOPER_GUIDE.rst




* Update DEVELOPER_GUIDE.rst




* Update DEVELOPER_GUIDE.rst




* fixed link format



---------




(cherry picked from commit 8f650e8)

Signed-off-by: Mitchell Gale <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Yury-Fridlyand <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants