Skip to content

docs: add CONTRIBUTING.md for local development workflow - #727

Open
seethinajayadileep wants to merge 1 commit into
ollama:mainfrom
seethinajayadileep:docs/add-contributing-md
Open

docs: add CONTRIBUTING.md for local development workflow#727
seethinajayadileep wants to merge 1 commit into
ollama:mainfrom
seethinajayadileep:docs/add-contributing-md

Conversation

@seethinajayadileep

Copy link
Copy Markdown

Summary

Adds a CONTRIBUTING.md so new contributors can set up the repo, run tests/lint, and open PRs without reverse-engineering CI.

Contents

  • Prerequisites and local setup (uv / Hatch and pip alternatives)
  • Repository layout (ollama/, tests/, examples/)
  • Running tests (uvx hatch test -acp)
  • Ruff format/lint checks matching CI
  • Pull request expectations

Test plan

  • Review CONTRIBUTING.md for accuracy against .github/workflows/test.yaml and pyproject.toml
  • Spot-check that documented Hatch commands match current CI

Fixes #686

Document setup, tests, lint/format, repository layout, and PR expectations
so new contributors do not need to reverse-engineer CI.

Fixes ollama#686

Signed-off-by: JAYA DILEEP <seethinajayadileep@hotmail.com>
@seethinajayadileep
seethinajayadileep marked this pull request as ready for review September 6, 2026 04:57
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.

Add a CONTRIBUTING.md to document the development workflow

1 participant