Thank you for your interest in contributing to OctalMesh projects.
We welcome community contributions and appreciate the time and effort you put into improving our software. This document outlines how to participate effectively and sets expectations for collaboration.
All contributors are expected to follow the Code of Conduct.
Please be respectful, constructive, and professional in all interactions.
You can contribute in several ways:
Bug reports help improve quality and reliability.
When opening an issue, please include:
- A clear and descriptive title
- Steps to reproduce the issue
- Expected and actual behavior
- Environment details (OS, version, software, runtime, etc.)
- Screenshots or logs, if applicable
Search existing issues before opening a new one.
Feature requests and improvements are welcome.
Please provide:
- The problem you are trying to solve
- Why this change would be useful
- Possible approaches or alternatives
Well-scoped and clearly motivated proposals are more likely to be accepted.
- Fork the repository
- Create a new branch from the default branch
- Make your changes, following existing style and conventions
- Commit with clear, meaningful messages
- Push your branch and open a pull request
Please ensure that:
- The project builds successfully
- Tests pass
- Changes are focused and not overly broad
- Related issues are referenced where relevant
Pull requests may be revised or declined if they do not align with the project goals or standards.
- Follow existing code style and formatting rules
- Avoid unrelated refactoring
- Keep changes minimal and well-scoped
- Document new behavior where appropriate
- Add or update tests when applicable
- Maintainers may request changes or clarification
- Reviews focus on correctness, clarity, and maintainability
- Approval does not guarantee immediate merge
All decisions are made in the interest of long-term project quality.
By contributing to this repository, you agree that your contributions will be licensed under the same license as the project.