Contributions

Thank you for your interest in contributing to Amplify Video. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

A reproducible test case or series of steps
The version of our code being used
Any modifications you've made relevant to the bug
Anything unusual about your environment or deployment

Finding Contribution Opportunities

Looking at the existing issues is a great way to find something to contribute. This project uses the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), so looking at any 'help wanted' issues is a great place to start.

Pull Requests

Pull requests are welcome!

Unless it's a trivial change, you should open an issue to discuss your pull request with the maintainers. This helps to ensure that the proposed change would be accepted and that you don't waste your own time. If you would like to implement support for a significant feature that is not yet available, please talk to us beforehand to avoid any duplication of effort.

Before sending us a pull request, please ensure that:

You are working against the latest source on the master branch.
You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
You open an issue to discuss any significant work - we would hate for your time to be wasted.

To send us a pull request, please:

Fork the repository.
Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. Eslint should always be run before submitting new pull requests by running npm run lint-fix. This should correct any naming conventions and covert spaces/tabs to the preferred defaults.
Ensure local tests pass.
Commit to your fork using clear commit messages.
Send us a pull request, answering any default questions in the pull request interface.
Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional document on forking a repository and creating a pull request.

Commit Style

Current version: Release

Using Cloudformation to deploy elemental: False

Version number meaning: x.y.z

x is major y is minor z is maintenance

Commit messages must follow:

Release vx.y.z
    
Initial plugin to create the elemental resources to host a AWS Video Services

- (Changes in details)

Please note this uses lambda functions to deploy the resources as there is no cloudformation support for elemental yet.