Skip to content

Contributing Guidelines

Thank you for your interest in contributing to azure-functions-langgraph.

For complete contributing guidelines, please see the CONTRIBUTING.md file in the repository root.

Quick reference

Setup

git clone https://github.com/yeongseon/azure-functions-langgraph-python.git
cd azure-functions-langgraph
make install

Before submitting a PR

make check-all

This runs:

  • ruff check — linting
  • mypy — type checking
  • pytest — test suite
  • bandit — security scan

PR checklist

  • [ ] Tests added for new functionality
  • [ ] All existing tests pass (make test)
  • [ ] Linting passes (make lint)
  • [ ] Type checking passes (make typecheck)
  • [ ] Documentation updated if public API changed
  • [ ] Commit messages follow Conventional Commits

Commit message format

Titles for issues, pull requests, and commits follow the Title Convention in CONTRIBUTING.md, the single source of truth for the format and the allowed types.

Development workflow

See Development for detailed setup and workflow instructions.