Contributing

Thanks for contributing!

Workflow

1. Create or assign yourself an issue.
2. Create a branch from main.
3. Make your changes.
4. Open a pull request.
5. Request a review.
6. Merge once approved.

Branch Naming

Use lowercase branch names with words separated by hyphens.

Format:

Examples:

dashboard-warning sd-logging setup-guide can-parser

If the work is associated with an issue, include the issue number:

42/dashboard-warning 17/dashboard-crash

Pull Requests

Please include:

• A brief summary
• Testing performed
• Related issue (e.g. Closes #42)

Code Reviews

Reviews are intended to improve code quality and share knowledge.

Authors should:

• Respond to feedback
• Ask questions if something is unclear
• Keep discussions constructive

Reviewers should:

• Be respectful
• Explain suggestions
• Focus on correctness, readability, and maintainability

Issues

Whenever possible, create an issue before beginning work.

Each issue should clearly describe:

• The problem
• Acceptance criteria
• Any useful references

Questions

If you're unsure about an implementation or design decision, ask before spending significant time on it.