Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (38 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 1.48 KB

Contributing to CodeFlow Engine

Thank you for your interest in contributing to CodeFlow Engine! This document provides guidelines and instructions for contributing.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Set up development environment (see README.md)
  4. Create a branch for your changes

Development Workflow

Code Style

  • Follow PEP 8 for Python code
  • Use type hints where appropriate
  • Write docstrings for all public functions and classes
  • Run ruff and mypy before committing

Testing

  • Write tests for new features
  • Ensure all tests pass: pytest
  • Maintain or improve test coverage

Documentation

  • Update relevant documentation for new features
  • Add docstrings to new functions/classes
  • Update README if needed

Pull Request Process

  1. Update CHANGELOG.md with your changes
  2. Ensure tests pass and coverage is maintained
  3. Update documentation as needed
  4. Create a pull request with a clear description
  5. Address review feedback promptly

Code Review Guidelines

  • Be respectful and constructive
  • Focus on code quality and maintainability
  • Ask questions if something is unclear
  • Approve when satisfied with changes

Reporting Issues

  • Use GitHub Issues for bug reports and feature requests
  • Provide clear reproduction steps for bugs
  • Include relevant environment information

Questions?

Feel free to open an issue or discussion for questions about contributing.