-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #222 from NOSALRO/contribution_guide
Contribution guideliness
- Loading branch information
Showing
3 changed files
with
146 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
Language: Cpp | ||
# BasedOnStyle: WebKit | ||
AccessModifierOffset: -4 | ||
AlignAfterOpenBracket: false | ||
AlignEscapedNewlinesLeft: false | ||
AlignOperands: false | ||
AlignTrailingComments: false | ||
AllowAllParametersOfDeclarationOnNextLine: true | ||
AllowShortBlocksOnASingleLine: true | ||
AllowShortCaseLabelsOnASingleLine: false | ||
AllowShortIfStatementsOnASingleLine: false | ||
AllowShortLoopsOnASingleLine: false | ||
AllowShortFunctionsOnASingleLine: All | ||
AlwaysBreakAfterDefinitionReturnType: false | ||
AlwaysBreakTemplateDeclarations: false | ||
AlwaysBreakBeforeMultilineStrings: false | ||
BreakBeforeBinaryOperators: All | ||
BreakBeforeTernaryOperators: true | ||
BreakConstructorInitializersBeforeComma: false | ||
BinPackParameters: true | ||
BinPackArguments: true | ||
ColumnLimit: 0 | ||
ConstructorInitializerAllOnOneLineOrOnePerLine: true | ||
ConstructorInitializerIndentWidth: 4 | ||
DerivePointerAlignment: false | ||
ExperimentalAutoDetectBinPacking: false | ||
IndentCaseLabels: false | ||
IndentWrappedFunctionNames: false | ||
IndentFunctionDeclarationAfterType: false | ||
MaxEmptyLinesToKeep: 1 | ||
KeepEmptyLinesAtTheStartOfBlocks: true | ||
NamespaceIndentation: All | ||
ObjCBlockIndentWidth: 4 | ||
ObjCSpaceAfterProperty: true | ||
ObjCSpaceBeforeProtocolList: true | ||
PenaltyBreakBeforeFirstCallParameter: 19 | ||
PenaltyBreakComment: 300 | ||
PenaltyBreakString: 1000 | ||
PenaltyBreakFirstLessLess: 120 | ||
PenaltyExcessCharacter: 1000000 | ||
PenaltyReturnTypeOnItsOwnLine: 60 | ||
PointerAlignment: Left | ||
SpacesBeforeTrailingComments: 1 | ||
Cpp11BracedListStyle: true | ||
Standard: Cpp11 | ||
IndentWidth: 4 | ||
TabWidth: 4 | ||
UseTab: Never | ||
BreakBeforeBraces: Stroustrup | ||
# SortIncludes: false | ||
SpacesInParentheses: false | ||
SpacesInSquareBrackets: false | ||
SpacesInAngles: false | ||
SpaceInEmptyParentheses: false | ||
SpacesInCStyleCastParentheses: false | ||
SpaceAfterCStyleCast: false | ||
SpacesInContainerLiterals: true | ||
SpaceBeforeAssignmentOperators: true | ||
ContinuationIndentWidth: 4 | ||
CommentPragmas: '^ IWYU pragma:' | ||
ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ] | ||
SpaceBeforeParens: ControlStatements | ||
DisableFormat: false | ||
... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
# Contributing to RobotDART | ||
|
||
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. | ||
|
||
## Table of Contents | ||
- [Contributing to RobotDART](#contributing-to-robotdart) | ||
- [Table of Contents](#table-of-contents) | ||
- [How to Contribute](#how-to-contribute) | ||
- [1. Fork the Repository](#1-fork-the-repository) | ||
- [2. Clone the Repository](#2-clone-the-repository) | ||
- [3. Create a Branch](#3-create-a-branch) | ||
- [4. Make Changes](#4-make-changes) | ||
- [5. Commit Your Changes](#5-commit-your-changes) | ||
- [6. Push Your Changes](#6-push-your-changes) | ||
- [7. Create a Pull Request](#7-create-a-pull-request) | ||
- [Pull Request Guidelines](#pull-request-guidelines) | ||
- [Issue Reporting](#issue-reporting) | ||
- [Coding Standards](#coding-standards) | ||
- [License](#license) | ||
|
||
## How to Contribute | ||
|
||
### 1. Fork the Repository | ||
Start by forking the repository to your GitHub account. This creates a copy of the project under your GitHub user. | ||
|
||
### 2. Clone the Repository | ||
Clone your forked repository to your local machine: | ||
```bash | ||
git clone https://github.com/your-username/robot_dart.git | ||
``` | ||
|
||
### 3. Create a Branch | ||
Create a new branch for your feature or bugfix: | ||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
### 4. Make Changes | ||
Implement your changes in your branch. | ||
|
||
### 5. Commit Your Changes | ||
Commit your changes with a descriptive commit message: | ||
```bash | ||
git commit -m "Add feature X" | ||
``` | ||
|
||
### 6. Push Your Changes | ||
Push your changes to your forked repository: | ||
```bash | ||
git push origin feature/your-feature-name | ||
``` | ||
|
||
### 7. Create a Pull Request | ||
Go to the original repository on GitHub and open a Pull Request from your branch. | ||
|
||
## Pull Request Guidelines | ||
- Ensure your code passes all tests. | ||
- Describe the purpose of the PR and what it aims to solve. | ||
- Include any relevant issue numbers in the PR description. | ||
- Follow the project’s coding standards. | ||
- Make sure your PR is up-to-date with the latest `master` branch. | ||
|
||
## Issue Reporting | ||
When reporting an issue, please include: | ||
- A clear and descriptive title. | ||
- A detailed description of the problem. | ||
- Steps to reproduce the issue. | ||
- Any relevant logs or screenshots. | ||
- Your system configuration (OS, compiler, etc.). | ||
|
||
## Coding Standards | ||
- Follow the existing [coding style](https://github.com/NOSALRO/robot_dart/blob/master/.clang-format) in the repository. | ||
- Document your code with comments. | ||
- Test your code thoroughly. | ||
|
||
## License | ||
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters