Skip to content

Contributing

Welcome! We're glad you're interested in contributing to NUClear.

Ways to Contribute

  • Report bugs — Open an issue on GitHub with a minimal reproducer
  • Suggest features — Describe your use case in a GitHub issue
  • Submit pull requests — Bug fixes, new features, documentation improvements
  • Improve documentation — Fix typos, add examples, clarify explanations

Getting Started

  1. Read the Development Setup guide to build and test locally
  2. Review the Code Style conventions
  3. Pick an issue labeled good first issue or open a new one to discuss your idea
  4. Fork the repo, create a branch, and submit a PR

Pull Request Guidelines

  • Keep PRs focused — one feature or fix per PR
  • Add tests for new functionality
  • Ensure all existing tests pass (ctest in the build directory)
  • Follow the existing code style

Code of Conduct

We expect all contributors to be respectful and constructive. Harassment, discrimination, and abusive behavior will not be tolerated. Be kind, assume good intent, and focus on the work.