Skip to content
Gaute Hope edited this page Mar 19, 2015 · 14 revisions

Contributing

Patches and pull-requests against the master branch may be submitted either as a pull-request here on github or as a patch (or series of) to:

Useful resources on how to contribute to a project using git can be found in the git-book Contributing to a Project, specifically the part about format-patch and the workflow for using different branches (these will form a pull-request if you choose that path).

Contributions in the form of testing and documentation is also very welcome.

All contributions must be made under the GNU GPL v3 licence or later.

Coding style

  • Two spaces for tabs
  • Otherwise, refer to the existing code-base

Tests

We use the Boost Test suite, refer to the test/ directory for how to set up a test. The test_generic may serve as a starting point. Remember to add the test to test/.gitignore and test/SConscript.

Code completion in Vim using YouCompleteMe

@ff2000 set up YouCompletMe completion for astroid in vim as in issue #14. We now include a default .ycm_extra_conf.py created as described in issue #14 and with the standard compile flags for on Arch Linux. To set up a compile_commands.json file one option is to use bear and to specify the current directory as the path to this file.

  1. Install YouCompleteMe
  2. Install bear
  3. Make a compile_commands.json file by running: devel/make_compile_commands.sh in the source root.

Clone this wiki locally