From 9687d5702ff8e11e38c051fc571aa821250bfb22 Mon Sep 17 00:00:00 2001 From: prachizala Date: Sun, 8 Nov 2026 21:11:06 +0530 Subject: [PATCH] docs: add comprehensive contributor guidelines and workflow Provides contributor onboarding guidelines, local environment setup instructions, and code standards. Co-authored-by: Claude --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9e7bdd8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing to Distributed Task Engine + +Thank you for your interest in contributing! We welcome bug fixes, documentation improvements, architectural proposals, and performance optimizations. + +## Getting Started +1. Fork the repository and clone your fork locally. +2. Create a virtual environment with Python 3.11+. +3. Install dependencies: `pip install -r requirements.txt`. +4. Install pre-commit or run `ruff check .` and `ruff format .` before pushing. + +## Development Workflow +- Create a feature branch: `git checkout -b feature/my-new-feature`. +- Write unit tests under `tests/` for any new logic. +- Run the test suite: `pytest -v`. +- Open a Pull Request targeting the `main` branch. + +## Code Standards +- Adhere to PEP 8 standards enforced via Ruff. +- Type hints are required for all public function signatures. +- Async database operations must use explicit transaction boundaries.