Modify the Template for Your New Package

When this template is used for a new package the following changes are needed:

[ ] Add your package file(s). You can use the file my-package.el as a template.
[ ] Remove the file my-package.el.
[ ] Change the main file in the Eldev.
[ ] Add your tests in ./tests. You can use test-my-package.el as a template which requires test-helper.el. This is an example of a file with auxiliary functions that can be used in other test files.
[ ] Change the Emacs version that should be tested in tests.yml. For linting and compiling the latest stable Emacs version is enough. Tests on the other hand should be done with the Emacs versions you want to support.
[ ] Remove this section.
[ ] Change the url of the badge to your repositiory.

Tips for Documentation

Foldable Section

The following construct can be used to make parts of this file foldable when rendered on github. This can be used to for instance describe multiple installation tools.

Title of Foldable Section

Content of foldable section.

Name of Package

Installation

Dependencies

Usage

Customization

Variables

Set the following variables to change the behaviour of the package:

Variable	Default	Description

Faces

The following faces are defined:

Face	Description

Key Bindings

Key	Action	Description

Hydra

Changelog

See the changelog.

Contributing

Use the issue tracker to reports bugs, suggest improvements or propose new features. If you want to contribute please open a pull request after having opened a new issue.

In any case please check out the contributing guidelines beforehand.

hubisan/emacs-lisp-package-template