-
Notifications
You must be signed in to change notification settings - Fork 393
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
25 additions
and
1 deletion.
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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
build*/ | ||
__pycache__ | ||
|
||
docs/_build/ | ||
|
||
.vscode/ | ||
.idea/ | ||
|
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,7 @@ | ||
# Contributing C | ||
|
||
Run `./format_code.sh` before committing to format the code. | ||
|
||
## Code Quality | ||
|
||
Code in the directory `lcmgen` leaks memory. It is not an uncommon practice to allow this for short lived CLI tools. |
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,6 @@ | ||
# Contributing Java | ||
|
||
`lcm.jar` along with `lcm-spy` and `lcm-logplayer-gui` are built with Cmake. There is not a Ant/Maven/Gradle project. | ||
To edit the code, use your IDE of choice to create a project in the `lcm-java` folder. `lcm-java/lcm` should be the top level package (`lcm.lcm.LCM` is the fully qualified name for the `LCM` class). | ||
|
||
To get the best results from Visual Studio Code, it may be necessary to first create an Eclipse project by using Eclipse. |
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,3 @@ | ||
# Contributing | ||
|
||
LCM uses the GNU LESSER GENERAL PUBLIC LICENSE. The full text may be found in the [COPYING](https://github.com/lcm-proj/lcm/blob/master/COPYING) file. |
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