Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (57 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

78 lines (57 loc) · 2.04 KB

Contributing Guide

We welcome contributions to the azure-functions-logging project.

Branch Strategy

Use GitHub Flow and branch from main.

Recommended branch prefixes:

  • feat/ for new features
  • fix/ for bug fixes
  • docs/ for documentation-only changes
  • chore/ for tooling and maintenance
  • ci/ for workflow updates

Development Workflow

  1. Create a branch from main. 
    git checkout main
git pull origin main
git checkout -b feat/your-feature-name
  2. Write code and tests.
  3. Run the local quality gate. 
    make check-all
  4. Push and create a pull request. 
    git push origin feat/your-feature-name

Project Commands

make format      # Format code with ruff
make lint        # Lint with ruff
make typecheck   # Type check with mypy
make test        # Run tests
make cov         # Run tests with coverage
make check-all   # Run the full local gate

Example Coverage Policy

Examples are part of the supported API experience and should stay verified.

  • Keep one representative example for the minimal structured logging workflow.
  • Keep one complex example for advanced configuration and context injection.
  • Add or update smoke tests whenever an example changes.
  • Prefer lightweight smoke coverage over infrastructure-heavy end-to-end tests.

Commit Message Guidelines

We follow the Conventional Commits specification.

Examples

git commit -m "feat: add OpenAPI 3.1 support"
git commit -m "fix: handle empty request body gracefully"
git commit -m "docs: improve quickstart documentation"
git commit -m "refactor: extract schema builder logic"
git commit -m "chore: update dev dependencies"

Use imperative present tense and keep the message concise.

Deployment

  • A merge to main triggers the production deployment workflow.
  • Deployment status can be tracked from the related GitHub Actions run.

Code of Conduct

Be respectful and inclusive. See our Code of Conduct for details.