2014-08-03 16:57:53 +00:00
|
|
|
# Contribution guidelines
|
|
|
|
|
|
2015-02-20 08:11:51 +00:00
|
|
|
Please open contributions as either issue reports or pull requests. We will ask
|
|
|
|
|
that anything that requires testing outside our normally supported platforms be
|
2014-08-03 16:57:53 +00:00
|
|
|
marked as such.
|
|
|
|
|
|
2015-02-20 08:11:51 +00:00
|
|
|
Style
|
|
|
|
|
-----
|
2014-08-03 16:57:53 +00:00
|
|
|
|
2015-02-20 08:11:51 +00:00
|
|
|
Please run all code against the following `astyle` command before sending in
|
2014-09-15 21:26:14 +00:00
|
|
|
a pull request:
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ astyle --style=linux --mode=c -n $file
|
|
|
|
|
```
|
|
|
|
|
|
2015-02-20 08:11:51 +00:00
|
|
|
It should be trivial to set up your text editor to do this for you. If you use
|
|
|
|
|
vim, add this to your vim configuration:
|
2014-09-15 21:26:14 +00:00
|
|
|
|
2015-02-20 08:11:51 +00:00
|
|
|
```vimscript
|
|
|
|
|
" Lvimrc
|
|
|
|
|
" if .lvimrc exists in current or parent directory of the currently loaded file,
|
|
|
|
|
" load it as config
|
|
|
|
|
if filereadable('../.lvimrc')
|
|
|
|
|
source ../.lvimrc
|
|
|
|
|
endif
|
|
|
|
|
if filereadable('./.lvimrc')
|
|
|
|
|
source ./.lvimrc
|
|
|
|
|
endif
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Otherwise please make sure the appropriate command is ran as part of your
|
|
|
|
|
editing process before you send a pull request. All pull requests that do not
|
|
|
|
|
follow the coding style will not be considered until they follow the coding
|
|
|
|
|
style.
|
|
|
|
|
|
|
|
|
|
Testing
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
When testing Elemental, please be sure to test it on a network of at least
|
|
|
|
|
3 instances of elemental. Please also be sure to have one of these instances
|
|
|
|
|
run **without** the patch you are testing, to be able to show that there is
|
|
|
|
|
a difference.
|
