Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (44 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

62 lines (44 loc) · 2.62 KB
Raw

Contributing to Slinky Containers

Thank you for your interest in contributing to Slinky Containers.

Ways to contribute

  1. Report a bug, request a feature, or suggest documentation changes Open an issue in this project: https://github.com/SlinkyProject/containers/issues. For bugs, include relevant environment and version details in the issue so we can reproduce the problem.

  2. Propose a larger feature Open an issue to describe the problem and proposed approach before investing significant implementation time, so maintainers can provide feedback on direction and design.

  3. Submit a fix or feature as a pull request Follow the Code contributions section below.

Issues and pull requests in this repository are handled on a best-effort basis. For production support, see SchedMD Support.

Code contributions

Development setup

Read README.md for clone, build, and test instructions for this repository.

Pull requests

  1. Fork or branch from main (unless a maintainer directs you otherwise).
  2. Pre-commit: With pre-commit installed on your machine, run pre-commit install from the repository root to register Git hooks, then run pre-commit install --install-hooks once to initialize hook environments. Do this before you commit so local checks match CI.
  3. Keep changes focused and include tests where appropriate.
  4. Update documentation if you change user-visible behavior.
  5. Open a pull request against this repository. Link related issues.
  6. Ensure CI passes; address review feedback.

Developer Certificate of Origin / sign-off

This project is released under the Apache License 2.0. By contributing, you agree that your contributions are licensed under that license. Use signed commits or include a Signed-off-by line in your commits as described in the Git documentation.

Community standards

Attribution

Project contributing guidelines are based on common open-source practice and the PLC-OSS-Template baseline used for NVIDIA OSS projects.