This document provides guidelines for contributing to the Cruise Control project.
- Ensure the bug has not already been reported by searching on GitHub under Issues.
- If you cannot find an open issue addressing the problem, open a new one. Include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the unexpected behavior.
- Use the relevant bug report templates to create the issue, if available.
- Please discuss first (open an issue) before starting any significant pull request (e.g., implementing features, refactoring code) to avoid spending time on something that might not be merged.
- Adhere to the project's coding conventions (indentation, accurate comments, etc.) and any other requirements (such as test coverage, documentation).
All YAML files must adhere to the following style guide:
- Indentation: Use 2 spaces for indentation.
- No trailing spaces.
- Use hyphens for list items.
- Use camelCase for key names.
- Ensure there are no syntax errors.
Additional rules:
- Always use double quotes for strings.
- Keep lines to a maximum of 80 characters.
- Ensure proper alignment of nested elements.
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
- Reference issues and pull requests liberally after the first line.