Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.73 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to our project! We welcome and appreciate all contributions. This document provides guidelines and steps for contributing.

Code of Conduct

All contributors are expected to follow our Code of Conduct. Please ensure you are welcoming and friendly in all of our spaces.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your machine.
  3. Create a new branch for your work.
  4. Make your changes.
  5. Commit your changes.
  6. Push your changes to your fork on GitHub.
  7. Create a pull request against the main branch of the original repository.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
  • Ensure your PR has a meaningful title.

Reporting Issues

If you believe you found a bug, please report it using the issue tracker. When filing an issue:

  • Provide a quick summary.
  • Include reproduction steps, environment details, and any other relevant information.
  • Attach logs or screenshots if possible.

Suggesting Enhancements

We love feedback. If you have a suggestion for improving the project, please open an issue for discussion.

Discussions

If you have questions, suggestions, or want to discuss topics related to the project, please open a discussion in the Discussions tab.

License

By contributing, you agree that your contributions will be licensed under the same license as the original project.

Thank you for your contribution!