Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (73 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

102 lines (73 loc) · 2.85 KB

Contributing to HandForge

Thanks for helping improve HandForge!

Code of Conduct

Please read and follow our CODE_OF_CONDUCT.md.

Development Setup

# Clone the repository
git clone https://github.com/VoxHash/HandForge.git
cd HandForge

# Install dependencies
pip install -r requirements.txt

# Ensure FFmpeg is installed and on PATH
# Windows: winget install ffmpeg
# Linux: sudo apt install ffmpeg

# Run the application
python -m handforge.app

Testing

Currently, HandForge is primarily tested manually. When contributing:

  • Test your changes on Windows, Linux, and macOS if possible
  • Test with various audio and video formats
  • Verify UI changes work correctly
  • Check for any regressions
  • Test edge cases (large files, invalid formats, etc.)

Branching & Commit Style

  • Branches: feature/..., fix/..., docs/..., chore/...
  • Conventional Commits: feat:, fix:, docs:, refactor:, test:, chore:

Examples:

  • feat: add hardware acceleration support
  • fix: resolve progress bar stuck at 99%
  • docs: update installation guide

Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Test your changes thoroughly
  5. Commit your changes with clear messages
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

PR Guidelines

  • Link related issues
  • Add tests if applicable
  • Update documentation as needed
  • Follow the PR template
  • Keep diffs focused and reviewable
  • Ensure code follows PEP 8 style guidelines

Coding Standards

  • Follow PEP 8 style guidelines
  • Use meaningful variable and function names
  • Add docstrings to functions and classes
  • Keep functions focused and small
  • Write clear commit messages
  • Use type hints where appropriate

Reporting Bugs

  1. Check if the bug has already been reported in Issues
  2. If not, create a new issue using the Bug Report template
  3. Provide as much detail as possible:
    • Steps to reproduce
    • Expected behavior
    • Actual behavior
    • System information (OS, Python version, FFmpeg version)

Suggesting Features

  1. Check if the feature has already been suggested
  2. Create a new issue using the Feature Request template
  3. Describe the feature and its use case

Release Process

  • We use Semantic Versioning (MAJOR.MINOR.PATCH)
  • Update CHANGELOG.md with all changes
  • Tag releases with version numbers
  • Release notes are generated from the changelog

Questions?

If you have questions, please open an issue or contact contact@voxhash.dev.

Thank you for contributing to HandForge!