Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (28 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.79 KB

Contributing

Thanks for helping improve this FFmpeg Lambda layer for Amazon Linux 2023.

Before you start

  • Search existing issues to avoid duplicates.
  • For large changes (FFmpeg version bumps, new architectures, SAR metadata), open an issue first so we can align on scope.

Development setup

Prerequisites match the README:

  • bash, curl, tar, xz
  • AWS CLI and AWS SAM CLI (for make publish only)
  • AWS credentials if you plan to deploy or publish
make build                    # stage ffmpeg/ffprobe into build/layer/bin
make build ARCH=arm64         # Graviton static build
make clean && make build      # force re-download from upstream

make deploy and make publish require DEPLOYMENT_BUCKET and real AWS resources. You do not need them for layer packaging changes.

Pull requests

  1. Fork the repo and create a branch from main.
  2. Keep changes focused; unrelated refactors make review harder.
  3. If you change template.yaml SAR metadata, bump SemanticVersion only when preparing a release (maintainers may handle this on merge).
  4. Update README.md when behavior, paths, or Makefile variables change.
  5. Open a PR and fill out the template checklist.

Licensing

Bundled FFmpeg is GPL-3.0-or-later. Contributions to this repository are accepted under the same license as the project (LICENSE). Do not submit proprietary or incompatible-licensed binary blobs.

Code review

Pull requests may require approval from code owners when that branch protection rule is enabled.

Questions

Use GitHub Discussions or open an issue labeled as a question if Discussions are not enabled.