Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 982 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 982 Bytes

Contributing to Video Generator API

We welcome contributions to the Video Generator API project!

Getting Started

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Run tests and linting: make test && make lint
  5. Commit your changes (see Commit Message Guidelines below)
  6. Push to your fork and submit a pull request

Commit Message Guidelines

We follow the Conventional Commits specification. Each commit message should be structured as follows:

<type>[optional scope]: <description>
[optional body]
[optional footer(s)]

Types: feat, fix, docs, style, refactor, perf, test, chore

Example: feat(api): add endpoint for video status retrieval

Code Style

  • Go: Follow the official Go style guide and use gofmt
  • Python: Follow PEP 8 and use Black for formatting

Reporting Bugs

Please use the issue tracker to report any bugs or feature requests.

Thank you for your contributions!