File: CONTRIBUTING.md

package info (click to toggle)
roboptim-core 2.0-7
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,488 kB
  • ctags: 1,160
  • sloc: cpp: 5,388; sh: 395; ansic: 387; makefile: 25; python: 19
file content (40 lines) | stat: -rw-r--r-- 1,200 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
Contributing to RobOptim
========================

First, thanks for your interest in RobOptim!

Before sending a pull request, please make sure that at least:

1. Your pull request compiles successfully.

For roboptim-core, Travis can check this for you one more time after
you sent your pull request. See
https://travis-ci.org/roboptim/roboptim-core.


2. The test suite is running ok (or if it was not running ok before
for some reason, make sure that additional tests are not failing).


3. Your patches must follow the RobOptim coding style.
Please try to mimic the current code layout as much as possible in
both interfaces and implementation files.


4. Do not break the API!
If you do so for a good reason, explain it thoroughly into your pull
request message.

5. RobOptim is licensed under LGPL-3. Make sure:
 - you agree with this license,
 - you are allowed to license your work under LGPL-3 (if you are
   contributing to RobOptim as a part of a paid work, check with your
   employer).


Do not wait before sending pull requests, RobOptim authors will help
you enhance your patch so that they make it into the master branch!


Thank you again for your participation,
The RobOptim team.