Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (41 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

54 lines (41 loc) · 1.42 KB

Contributing to ScriptForge 🎬

Thank you for your interest in contributing to ScriptForge! This document provides guidelines for contributing.

🚀 Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/scriptforge.git
  3. Install in development mode: pip install -e .
  4. Run tests: python -m pytest tests/

📋 Development Guidelines

Code Style

  • Follow PEP 8 conventions
  • Use type hints where possible
  • Keep functions focused and under 50 lines
  • Add docstrings to all public functions and classes

Commit Messages

Follow the Angular commit convention:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation updates
  • refactor: Code refactoring
  • test: Test additions/changes
  • chore: Maintenance tasks

Pull Request Process

  1. Create a feature branch from main
  2. Write/update tests for your changes
  3. Ensure all tests pass
  4. Update documentation if needed
  5. Submit PR with clear description

🐛 Reporting Issues

When reporting bugs, please include:

  • Python version
  • Operating system
  • Steps to reproduce
  • Expected vs actual behavior
  • Error messages (if any)

💡 Feature Requests

Feature requests are welcome! Please describe:

  • The problem you're trying to solve
  • Your proposed solution
  • Any alternatives you've considered

📄 License

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