Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (45 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 2.38 KB
Raw

Contributing to CuOS (Container Update OS)

We welcome contributions from the community!

  • All contributors are expected to follow our Code of Conduct.
  • All contributions must comply with the Developer Certificate of Origin (DCO). This means adding a Signed-off-by line to your commits.
  • Contributions are accepted under the project's license, Apache-2.0, as stated in each source file's SPDX-License-Identifier line. You keep the copyright to your contribution.

🚀 Why Contribute?

CuOS is built on the idea that your OS should be managed just like your containers. By contributing, you're helping create a system where:

  • All tools and configurations are defined in a container image.
  • Updates are automatic and rollback-safe.
  • The OS is reproducible, scalable, and fleet-ready.
  • Developers can reuse their container knowledge to manage entire systems.

🧰 Getting Started

1. Fork the Repository

Click the Fork button on GitHub to create your own copy of the project.

2. Clone Your Fork

git clone https://github.com/your-username/cuos.git
cd cuos

🐛 Reporting Issues

If you encounter a bug or have a feature request:

1 Check the issue tracker to see if it’s already reported. 2 If not, open a new issue with: * A clear title and description * Steps to reproduce (if applicable) * Expected vs. actual behavior * Logs or screenshots if helpful

✨ Submitting Pull Requests

1 Create a new branch off development: git checkout -b feature/your-feature-name origin/development

2 Make your changes and commit them: git commit -m "feat: your feature description"

3 Sign off your commits with git commit -s. This is required for every commit — see Developer Certificate of Origin (DCO).

4 Open the pull request against development. main carries the released state only and is fast-forwarded from development at release time.

🤝 Community Guidelines

We value respectful, inclusive, and constructive collaboration. Please:

  • Be kind and respectful in all interactions.
  • Use clear and concise language.
  • Provide helpful feedback and be open to receiving it.
  • Follow the Code of Conduct.

Thank you for helping make CuOS better!