Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (43 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 1.39 KB
Raw

Contributing

Thanks for helping improve PureAutoCodeQL.

Development Setup

git clone https://github.com/Fruit-Guardians/PureAutoCodeql.git
cd PureAutoCodeql
uv sync

Build the MCP ripgrep tool when you need agent-side code search:

chmod +x scripts/build_mcp.sh
./scripts/build_mcp.sh

Run the environment doctor on a new machine:

uv run python Analyze.py --doctor
uv run pure-auto-codeql doctor

Before Opening a Pull Request

Please run the focused checks that match your change. For broad changes, run:

uv run pytest -q
uv lock --check
uv run python -m compileall -q Analyze.py api core services utils pure_auto_codeql tools

For documentation-only changes, at minimum check Markdown links and run:

git diff --check

Pull Request Guidance

  • Keep the change focused and explain why it is needed.
  • Include reproduction steps for bug fixes.
  • Include sample input or output when behavior changes.
  • Do not commit secrets, generated local reports, or private target projects.
  • Do not commit editor or local agent configuration directories such as .vscode/, .cursor/, .windsurf/, or .trae/.
  • Follow existing module boundaries and local coding style.

Commit Message Examples

fix: harden project import path validation
feat: add source-sink fallback query mode
docs: refresh API quickstart
test: cover unsafe case id rejection