Skip to content

Commit 0bd4ac9

Browse files
authored
Merge pull request #222 from NOSALRO/contribution_guide
Contribution guideliness
2 parents b6e4791 + a1fdc2e commit 0bd4ac9

File tree

3 files changed

+146
-0
lines changed

3 files changed

+146
-0
lines changed

.clang-format

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
Language: Cpp
3+
# BasedOnStyle: WebKit
4+
AccessModifierOffset: -4
5+
AlignAfterOpenBracket: false
6+
AlignEscapedNewlinesLeft: false
7+
AlignOperands: false
8+
AlignTrailingComments: false
9+
AllowAllParametersOfDeclarationOnNextLine: true
10+
AllowShortBlocksOnASingleLine: true
11+
AllowShortCaseLabelsOnASingleLine: false
12+
AllowShortIfStatementsOnASingleLine: false
13+
AllowShortLoopsOnASingleLine: false
14+
AllowShortFunctionsOnASingleLine: All
15+
AlwaysBreakAfterDefinitionReturnType: false
16+
AlwaysBreakTemplateDeclarations: false
17+
AlwaysBreakBeforeMultilineStrings: false
18+
BreakBeforeBinaryOperators: All
19+
BreakBeforeTernaryOperators: true
20+
BreakConstructorInitializersBeforeComma: false
21+
BinPackParameters: true
22+
BinPackArguments: true
23+
ColumnLimit: 0
24+
ConstructorInitializerAllOnOneLineOrOnePerLine: true
25+
ConstructorInitializerIndentWidth: 4
26+
DerivePointerAlignment: false
27+
ExperimentalAutoDetectBinPacking: false
28+
IndentCaseLabels: false
29+
IndentWrappedFunctionNames: false
30+
IndentFunctionDeclarationAfterType: false
31+
MaxEmptyLinesToKeep: 1
32+
KeepEmptyLinesAtTheStartOfBlocks: true
33+
NamespaceIndentation: All
34+
ObjCBlockIndentWidth: 4
35+
ObjCSpaceAfterProperty: true
36+
ObjCSpaceBeforeProtocolList: true
37+
PenaltyBreakBeforeFirstCallParameter: 19
38+
PenaltyBreakComment: 300
39+
PenaltyBreakString: 1000
40+
PenaltyBreakFirstLessLess: 120
41+
PenaltyExcessCharacter: 1000000
42+
PenaltyReturnTypeOnItsOwnLine: 60
43+
PointerAlignment: Left
44+
SpacesBeforeTrailingComments: 1
45+
Cpp11BracedListStyle: true
46+
Standard: Cpp11
47+
IndentWidth: 4
48+
TabWidth: 4
49+
UseTab: Never
50+
BreakBeforeBraces: Stroustrup
51+
# SortIncludes: false
52+
SpacesInParentheses: false
53+
SpacesInSquareBrackets: false
54+
SpacesInAngles: false
55+
SpaceInEmptyParentheses: false
56+
SpacesInCStyleCastParentheses: false
57+
SpaceAfterCStyleCast: false
58+
SpacesInContainerLiterals: true
59+
SpaceBeforeAssignmentOperators: true
60+
ContinuationIndentWidth: 4
61+
CommentPragmas: '^ IWYU pragma:'
62+
ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ]
63+
SpaceBeforeParens: ControlStatements
64+
DisableFormat: false
65+
...

.github/CONTRIBUTING.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
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+

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ This work was conducted within the [Laboratory of Automation and Robotics](https
4848
<img src="http://resibots.eu/_static/resibots_logo_black_200px.png" alt="logo_resibots"/>
4949
</p> -->
5050

51+
## Contributing
52+
53+
Check out our [contribution guidelines](https://github.com/NOSALRO/robot_dart/tree/master/.github/CONTRIBUTING.md) to get started.
5154

5255
## License
5356

0 commit comments

Comments
 (0)