Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.12 KB
Raw

Contributing to DevForge

Thank you for your interest in contributing to DevForge! We welcome contributions from the community.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a feature branch (git checkout -b feature/my-feature)
  4. Make your changes
  5. Push to your fork and open a Pull Request

Development Setup

Each tool in the DevForge suite is a standalone Python package. See individual tool repositories for specific setup instructions.

Code Style

  • Follow PEP 8 for Python code
  • Use type hints where possible
  • Write docstrings for public functions and classes
  • Keep functions focused and small

Pull Request Process

  1. Ensure your code passes all existing tests
  2. Add tests for any new functionality
  3. Update documentation as needed
  4. Keep PRs focused on a single change
  5. Wait for review from a maintainer

Reporting Issues

  • Use GitHub Issues to report bugs or request features
  • Include steps to reproduce for bug reports
  • Search existing issues before creating new ones

License

By contributing, you agree that your contributions will be licensed under the MIT License.