File: CONTRIBUTING.org

package info (click to toggle)
ess 24.01.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,780 kB
  • sloc: lisp: 23,993; makefile: 339; sh: 7
file content (29 lines) | stat: -rw-r--r-- 1,114 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
* Contributing code
Please make sure your contribution:

- Does not introduce any byte compilation warnings or cause existing
  tests to fail (=make test=)
- Satisfies M-x checkdoc

We follow standard Elisp coding conventions with the following
exceptions:

- =indent-tabs-mode= should be =nil=
- =sentence-end-double-space= should be =nil=

Both of these are taken care of by the .dir-locals.el file. We do not
require internal functions to be documented if their name is
descriptive enough.

If you have contributed to ESS in the past but changed your git
username or email, please add the proper alias to .mailmap (see
git-shortlog(1) for the format).

** FSF copyright assignment

Unless your change is less than about 15 lines of code, you must
assign copyright to the FSF. This is the same process that Emacs
itself and all packages in GNU ELPA use (the paperwork can cover
both). Instructions for this process can be found [[https://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/Copyright/request-assign.future][here]]. If you have
already signed the paperwork for GNU Emacs, nothing else needs to be
done.