Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 1.98 KB

CONTRIBUTING.org

File metadata and controls

61 lines (43 loc) · 1.98 KB
Raw

Contributing

Running tests

There are a couple of dependencies in order to run tests. These dependencies will be picked up directly by the vendor make task. You can run it by performing:

$ make vendor

The vendor task is already called by other tasks such as lint. Thus, if you just want to run everything, just execute:

$ make

This will fetch the dependencies for you and run the style checkers and the tests, among other things. See the sections below to read more about them.

Checking the style

The elisp-lint and package-lint packages are being used for checking the style. You can run these checkers by performing:

$ make lint

Load test

In order to test that this theme can be actually loaded, run:

$ make load-test

Issue reporting

I’m using Github in order to host the code. Thus, in order to report issues you can do it on its issue tracker. A couple of notes on reports:

  • Check that the issue has not already been reported or fixed in master.
  • Try to be concise and precise in your description of the problem.
  • Provide a step by step guide on how to reproduce this problem.
  • Provide the version you are using (the commit SHA, if possible), as well as the version of the GNU Emacs you are using and the operating system.

Pull requests

  • Write a good commit message.
  • Make sure that tests are passing on your local machine (it will also be checked by the CI system whenever you submit the pull request).
  • Update the changelog (if relevant).
  • Open a pull request with only one subject and a clear title and description. Refrain from submitting pull requests with tons of different unrelated commits.