Contribution Guide

We welcome all kinds of contributions, including but not limited to bug reports, documentation improvements, new features, and bug fixes. Please ensure to always open an issue to discuss the changes you want to make before sending a pull request.

Overview

1. Ensure there is an opened GitHub issue corresponding to the changes you want to make.
2. Self-assign the GitHub issue.
3. Fork the repository by visiting ros2-essentials and clicking the "Fork" button.
4. Clone the forked repository to your local machine, e.g., git clone git@github.com:username/ros2-essentials.git
5. Create a new branch for your changes, e.g., git checkout -b feat/your-feature-name for a feature branch or git checkout -b fix/your-bug-name for a bug fix branch.
6. Make your changes and ensure they are tested.
7. Push your local changes to your forked repository, e.g., git push origin feat/your-feature-name.
8. Create a pull request to merge your changes into the main repository's main branch.

Guidelines

1. Commit messages should follow the conventional commit format.
2. Commit description should include as much details as possible. Try to include references you consulted and your rationale behind the changes. This will be essential for reviewers to understand the changes and for future reference. (e.g., 058ff59)
3. If copied files from other sources, please include the source in the commit message. If copied from GitHub, include the permalink (link with commit ID) and the branch name. (e.g., 6a2dac1)
4. Each commit should be atomic and self-contained.
5. If anyone helped you during the development, please include them in the commit message using the Co-authored-by format. (e.g., 4f9832d)
6. Refrain from force-pushes after a reviewer has started reviewing your changes.

Use git log and search for related commits to understand the commit message format.

Linting

Basic linting is done by running the following script:

tests/test_all.sh