Contributing
Submitting a PR

Pull Request Process

This document outlines the process for submitting a pull request to our project.

Before Submitting a Pull Request

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.

Submitting a Pull Request

  1. Fork the repository and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!
  7. Optionally add your social so that we can tag you when we share an update.

After Submitting a Pull Request

  1. The maintainers will review your PR within a few days.
  2. They may ask for changes or improvements.
  3. Once approved, your PR will be merged into the main branch.

Remember, the better you describe your pull request and the changes it introduces, the easier it will be for maintainers to review and merge it.