Skip to content

Conversation

@adhraj12
Copy link

Fixes #3105

Motivation

As a new contributor, I found that having a dedicated local setup guide clarifies the prerequisites and build steps.

Modifications

  • Added docs/local_setup.md to provide a clear entry point for new developers.
  • Included specific troubleshooting for "unmappable character" errors on Windows (-Dfile.encoding=UTF-8), which I discovered and verified during my own setup.

Verification

  • Verify design and implementation: Created a new markdown guide based on repository standards.
  • Verify test coverage and CI build status: Manually verified the build locally using the instructions in the new guide. (Build Successful).
  • Verify documentation: This PR is documentation.

Committer Checklist

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

@CLAassistant
Copy link

CLAassistant commented Dec 24, 2025

CLA assistant check
All committers have signed the CLA.

@adhraj12 adhraj12 changed the title Docs/setup guide docs: add beginner-friendly local setup guide Dec 24, 2025
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.

docs: beginner-friendly local setup guide for new contributors

2 participants