Contributing

Contributions are welcome. If you discover bugs or issues, or have ideas for improvements or new features, please file a report on the issue tracker for this repository. Follow the guidelines below to make sure everything goes smoothly.

Issue reporting

Check that the issue has not already been reported
Check that the issue has not already been fixed in the latest code
Open an issue with a clear title
Write as grammatically correct as you can in the description.

Pull requests

Perform all changes on a topic branch for easier merging
Follow the coding conventions already in use
Verify Emacs Lisp code with checkdoc
Add unit tests whenever possible
Open a pull request relating to a single issue.

Coding Conventions

Naming

Use a beginend- prefix for all public names.
Use a beginend-- prefix for all internal names.

Docstrings

Write meaningful docstrings for all functions and vars.

Document all functions and variables as directed by checkdoc.
Consider using Flycheck to automate checkdoc while you're editing.