2.4 KiB
Contributing to OpenBuilds-CONTROL
Thank you for your interest in contributing to OpenBuilds-CONTROL! Whether you're reporting bugs, improving documentation, or writing code, we welcome your contributions. Please take a moment to review this document before you begin contributing.
Table of Contents
Code of Conduct
This project adheres to the [OpenBuilds Code of Conduct](link to code of conduct). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email@example.com].
How to Contribute
Reporting Bugs
If you find a bug, please submit an issue through the GitHub Issues page. Provide detailed information, including:
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Screenshots or error logs, if applicable
- Version of OpenBuilds-CONTROL and environment details (OS, hardware, etc.)
Submitting Pull Requests
We welcome pull requests (PRs) for fixes, features, and improvements! Please ensure:
- You fork the repository and create your PR from a feature branch.
- Your PR is focused on one change (fix, feature, or improvement).
- Include tests and documentation updates where applicable.
- Ensure the code adheres to the existing style and passes all tests.
Steps to Submit a PR:
- Fork the repository and clone it locally.
- Create a new branch from
main(e.g.,feature/your-feature-name). - Make your changes and commit them with a descriptive message.
- Push the branch to your forked repository.
- Open a pull request against the
mainbranch of OpenBuilds-CONTROL. - Ensure your PR passes all continuous integration (CI) checks.
Commit Message Guidelines
Please follow these guidelines for writing commit messages:
- Use the present tense ("Add feature" not "Added feature").
- Keep messages concise but descriptive.
- Capitalize the subject line and do not exceed 50 characters.
- Reference relevant issues or PRs when applicable.
License
By contributing, you agree that your contributions will be licensed under the [LICENSE](link to LICENSE) of the repository.