From cc0c8d338d756bb890d81c2569c0f7a75007bfcf Mon Sep 17 00:00:00 2001 From: Sam Dodrill Date: Fri, 20 Feb 2015 00:11:51 -0800 Subject: [PATCH] Update contributing guidelines --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a05a7f..6b23a8a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,20 +1,43 @@ # Contribution guidelines -Please open contributions as either issue reports or pull requests. We will ask -that anything that requires testing outside our normally supported platforms be +Please open contributions as either issue reports or pull requests. We will ask +that anything that requires testing outside our normally supported platforms be marked as such. -As ircd is such an ancient project with varying code styles, please try to -follow the current coding style of the file you are in. If all else fails, -please use the [Linux Kernel](https://www.kernel.org/doc/Documentation/CodingStyle) -coding style. +Style +----- -Please run all code against the following `astyle` command before sending in +Please run all code against the following `astyle` command before sending in a pull request: ```console $ astyle --style=linux --mode=c -n $file ``` -It should be trivial to set up your text editor to do this for you. +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: +```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.