Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (39 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 2.46 KB

Contributing to DART

Thank you for your interest in contributing to DART! We welcome contributions of all kinds: bug fixes, new features, documentation improvements, and more.

Quick Start

  1. New to DART? Read the Developer Onboarding Guide
  2. Ready to contribute? See Contribution Workflow
  3. Building from source? Follow the Build Guide
  4. Code style? Check the Style Guide

How to Contribute

The best way to contribute is by opening a GitHub pull request. Make sure your code follows DART conventions (see style guide).

Don't worry about perfection! Feel free to post work-in-progress versions to get feedback and start the discussion.

Copyright Headers

All source files should include a copyright header. We use the year of first publication (2011) following FSFE REUSE best practices:

/*
 * Copyright (c) 2011, The DART development contributors
 * All rights reserved.
 *
 * The list of contributors can be found at:
 *   https://github.com/dartsim/dart/blob/main/LICENSE
 *
 * This file is provided under the following "BSD-style" License:
 *   ...
 */

Important: Do NOT update the year when modifying files. The year represents the first publication date of the project, not the last modification. This follows industry best practice (used by Google, curl, Gazebo, etc.) and eliminates unnecessary maintenance.

Before Submitting a PR

  • Code follows the DART style guide
  • Build succeeds: pixi run build or cmake --build build/
  • Tests pass: pixi run test or cmake --build build/ --target test
  • Code is formatted: make format (in build directory)
  • Documentation is updated if needed

Getting Help

Contributors

DART is developed by a diverse community of researchers and engineers. See the full contributor list for acknowledgments.

License

By contributing to DART, you agree that your contributions will be licensed under the BSD 2-Clause License.