Contributions are welcome! Please open an issue if you find a bug, have a feature request, or have any suggestions for the project at all. Also feel free to make pull requests yourself instead of issues, or make pull requests for any existing unresolved issues. Try to follow the following guidelines if you open an issue or pull request:
- 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.
main). - 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).
- Add tests (if possible) to cover your change(s)
- Follow the Emacs Lisp conventions and the Emacs Lisp Style Guide
- 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) - 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.
Check ci.yml to see all the details for the testing frameworks being used, the Emacs versions being tested, and the command(s) required to run the tests. TLDR: Cask and buttercup are used for testing and can be run like so:
cask install
cask exec buttercup -L .
This package is subject to the same Copyright Assignment policy as GNU Emacs and all other packages in GNU ELPA.
Any legally significant contributions can only be accepted after the author has completed their paperwork. Please see the request form if you want to proceed with the assignment.
The copyright assignment isn't a big deal, it just says that the copyright for your submitted changes to Emacs belongs to the FSF. This assignment works for all projects related to Emacs. To obtain it you need to:
- Send one email
- Send one letter (if you live in the US, it's digital)
- Wait for some time (recently it's less than a week)