Skip to content

docs: add ErrorProne and NullAway integration guide and JSpecify migration playbook - #13882

Open
nnicolee wants to merge 3 commits into
mainfrom
feat/jspecify-docs
Open

docs: add ErrorProne and NullAway integration guide and JSpecify migration playbook#13882
nnicolee wants to merge 3 commits into
mainfrom
feat/jspecify-docs

Conversation

@nnicolee

Copy link
Copy Markdown
Contributor

This PR introduces two reference documents under the docs/ directory to guide development teams and tooling through adopting strict null-safety compilation checks.

Documents Added

  1. docs/errorprone_nullaway_integration_guide.md

    • Guides basic ErrorProne setup and NullAway integration (JSpecify Mode).
    • Details compilation parameters, Maven/Gradle plugin configurations, on-demand profile definitions, and success verification procedures.
    • Documents JDK 17/21 type-annotation preservation requirements and recommended NullAway version boundaries to prevent analyzer exceptions.
  2. docs/jspecify_automation_migration_playbook.md

    • Lays out a systematic 3-step playbook for migrating codebase libraries (bulk class-level annotation scripting, legacy javax transition, and compiler-assisted in-place auto-patching).

@nnicolee
nnicolee marked this pull request as ready for review July 23, 2026 19:50
@nnicolee
nnicolee requested review from a team as code owners July 23, 2026 19:50
gemini-code-assist[bot]

This comment was marked as resolved.

@nnicolee
nnicolee requested a review from lqiu96 July 23, 2026 19:55
@nnicolee nnicolee added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jul 23, 2026
@lqiu96 lqiu96 changed the title feat: add ErrorProne and NullAway integration guide and JSpecify migration playbook docs: add ErrorProne and NullAway integration guide and JSpecify migration playbook Jul 24, 2026
@lqiu96

lqiu96 commented Jul 24, 2026

Copy link
Copy Markdown
Member

Reviewed the internals docs and approved. Going to approve on GH. Please make the suggested changes from the internal doc and code assist suggestions before merging! Thanks!

@nnicolee

Copy link
Copy Markdown
Contributor Author

/gemini review

gemini-code-assist[bot]

This comment was marked as resolved.

@nnicolee nnicolee removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants