|
| 1 | +# Contributing to RobotDART |
| 2 | + |
| 3 | +Thank you for your interest in contributing to RobotDART! We appreciate your help in improving the project. Below are some guidelines to help you get started. |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | +- [Contributing to RobotDART](#contributing-to-robotdart) |
| 7 | + - [Table of Contents](#table-of-contents) |
| 8 | + - [How to Contribute](#how-to-contribute) |
| 9 | + - [1. Fork the Repository](#1-fork-the-repository) |
| 10 | + - [2. Clone the Repository](#2-clone-the-repository) |
| 11 | + - [3. Create a Branch](#3-create-a-branch) |
| 12 | + - [4. Make Changes](#4-make-changes) |
| 13 | + - [5. Commit Your Changes](#5-commit-your-changes) |
| 14 | + - [6. Push Your Changes](#6-push-your-changes) |
| 15 | + - [7. Create a Pull Request](#7-create-a-pull-request) |
| 16 | + - [Pull Request Guidelines](#pull-request-guidelines) |
| 17 | + - [Issue Reporting](#issue-reporting) |
| 18 | + - [Coding Standards](#coding-standards) |
| 19 | + - [License](#license) |
| 20 | + |
| 21 | +## How to Contribute |
| 22 | + |
| 23 | +### 1. Fork the Repository |
| 24 | +Start by forking the repository to your GitHub account. This creates a copy of the project under your GitHub user. |
| 25 | + |
| 26 | +### 2. Clone the Repository |
| 27 | +Clone your forked repository to your local machine: |
| 28 | +```bash |
| 29 | +git clone https://github.com/your-username/robot_dart.git |
| 30 | +``` |
| 31 | + |
| 32 | +### 3. Create a Branch |
| 33 | +Create a new branch for your feature or bugfix: |
| 34 | +```bash |
| 35 | +git checkout -b feature/your-feature-name |
| 36 | +``` |
| 37 | + |
| 38 | +### 4. Make Changes |
| 39 | +Implement your changes in your branch. |
| 40 | + |
| 41 | +### 5. Commit Your Changes |
| 42 | +Commit your changes with a descriptive commit message: |
| 43 | +```bash |
| 44 | +git commit -m "Add feature X" |
| 45 | +``` |
| 46 | + |
| 47 | +### 6. Push Your Changes |
| 48 | +Push your changes to your forked repository: |
| 49 | +```bash |
| 50 | +git push origin feature/your-feature-name |
| 51 | +``` |
| 52 | + |
| 53 | +### 7. Create a Pull Request |
| 54 | +Go to the original repository on GitHub and open a Pull Request from your branch. |
| 55 | + |
| 56 | +## Pull Request Guidelines |
| 57 | +- Ensure your code passes all tests. |
| 58 | +- Describe the purpose of the PR and what it aims to solve. |
| 59 | +- Include any relevant issue numbers in the PR description. |
| 60 | +- Follow the project’s coding standards. |
| 61 | +- Make sure your PR is up-to-date with the latest `master` branch. |
| 62 | + |
| 63 | +## Issue Reporting |
| 64 | +When reporting an issue, please include: |
| 65 | +- A clear and descriptive title. |
| 66 | +- A detailed description of the problem. |
| 67 | +- Steps to reproduce the issue. |
| 68 | +- Any relevant logs or screenshots. |
| 69 | +- Your system configuration (OS, compiler, etc.). |
| 70 | + |
| 71 | +## Coding Standards |
| 72 | +- Follow the existing [coding style](https://github.com/NOSALRO/robot_dart/blob/master/.clang-format) in the repository. |
| 73 | +- Document your code with comments. |
| 74 | +- Test your code thoroughly. |
| 75 | + |
| 76 | +## License |
| 77 | +By contributing, you agree that your contributions will be licensed under the same [BSD 2-Clause License](https://github.com/NOSALRO/robot_dart?tab=BSD-2-Clause-1-ov-file#readme) that covers the project. |
| 78 | + |
0 commit comments