Skip to content

docs: add comprehensive contributor guidelines and workflow #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
prachizala merged 1 commit into from
Nov 8, 2026
Merged

docs: add comprehensive contributor guidelines and workflow #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading