Skip to content

Latest commit

 

History

History
74 lines (63 loc) · 3.01 KB

CONTRIBUTING.org

File metadata and controls

74 lines (63 loc) · 3.01 KB
Raw

Reporting issues

Before reporting a bug, please take a look at:

To understand what’s going on, we need a reproducible bug scenario. It is important that we can rule out interference with other Emacs packages or customizations, therefore use emacs -Q to bypass your init file.

This shortcut will start emacs -Q for you with ivy-mode already loaded:

git clone https://github.com/abo-abo/swiper/
cd swiper
make plain

Contributing code

Here are the important settings for code style:

(setq indent-tabs-mode nil)
(require 'cl-indent)
(setq lisp-indent-function #'common-lisp-indent-function)
(put 'if 'common-lisp-indent-function 2)
(put 'defface 'common-lisp-indent-function 1)
(put 'defalias 'common-lisp-indent-function 1)
(put 'define-minor-mode 'common-lisp-indent-function 1)
(put 'define-derived-mode 'common-lisp-indent-function 3)
(put 'cl-flet 'common-lisp-indent-function
     (get 'flet 'common-lisp-indent-function))
(put 'cl-labels 'common-lisp-indent-function
     (get 'labels 'common-lisp-indent-function))

The setting for indent-tabs-mode is automatically applied by .dir-locals.el. Emacs produces a warning when setting lisp-indent-function in .dir-locals.el, so that line is commented out. Please uncomment it and add the following code to disable the warning:

(add-to-list 'safe-local-variable-values
             '(lisp-indent-function . common-lisp-indent-function))

Before submitting a change, run:

  • make compile - check for new compilation warnings
  • make deps - install dependencies for testing
  • make test - check for failing tests
  • make checkdoc - check documentation guidelines

Use your own judgment for the commit messages, I recommend a verbose style using magit-commit-add-log.

Copyright Assignment

These packages are subject to the same Copyright Assignment policy as Emacs itself, org-mode, CEDET and 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
  • then send one letter (if you live in the US, it’s digital)
  • wait for some time (in my case, I had to wait for one month; but recently it’s less than a week)