Skip to content
Permalink
master
Go to file
 
 
Cannot retrieve contributors at this time
34 lines (28 sloc) 1.62 KB

Contributing

If you discover issues, have ideas for improvements or new features, please report them to the issue tracker of the repository or submit a pull request. Please, try to follow these guidelines when you do so.

Issue reporting

  • Check that the issue has not already been reported.
  • Check that the issue has not already been fixed in the latest code (a.k.a. master).
  • Be clear, concise and precise in your description of the problem.
  • Open an issue with a descriptive title and a summary in grammatically correct, complete sentences.
  • Include any relevant code to the issue summary.
  • If you're reporting performance issues it'd be nice if you added some profiling data (Emacs has a built-in profiler).

Pull requests

  • Read how to properly contribute to open source projects on Github.
  • Use a topic branch to easily amend a pull request later, if necessary.
  • Write good commit messages.
  • Mention related tickets in the commit messages (e.g. [Fix #N] Add missing autoload cookies)
  • Update the changelog.
  • Use the same coding conventions as the rest of the project.
  • Verify your Emacs Lisp code with checkdoc (C-c ? d).
  • Open a pull request that relates to only one subject with a clear title and description in grammatically correct, complete sentences.
You can’t perform that action at this time.