We'd be happy for you to contribute to Elpy.
You can set up a working environment for Elpy using pip
and
cask
. After installing Cask, just run the setup
script:
virtualenv ~/.virtualenvs/elpy source ~/.virtualenvs/elpy/bin/activate ./scripts/setup
You can now run ./scripts/test
to run Elpy's test suite.
Please follow PEP 8 in Python source, and provide automated tests that cover your code. Aim for full coverage of your code.
Follow standard Emacs Lisp coding guidelines. All globally defined
symbols should start with elpy-
. Mark internal functions with a
double dash, like elpy-config--insert-configuration-problems
. Do
not be afraid of long symbol names.
Emacs Lisp tests can be found in the test/
directory. They
generally follow the file name format <function-name>-test.el
.
Please provide at least one test per function you define.