emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] master d899181 199/272: README.md: Add a section on Contributing


From: Oleh Krehel
Subject: [elpa] master d899181 199/272: README.md: Add a section on Contributing
Date: Mon, 25 Apr 2016 10:13:25 +0000

branch: master
commit d8991813a24f64eb716183a1e740658c99f411ea
Author: Oleh Krehel <address@hidden>
Commit: Oleh Krehel <address@hidden>

    README.md: Add a section on Contributing
    
    Just copy from avy.
---
 .dir-locals.el |    5 +++++
 README.md      |   16 ++++++++++++++++
 2 files changed, 21 insertions(+)

diff --git a/.dir-locals.el b/.dir-locals.el
new file mode 100644
index 0000000..3bcda92
--- /dev/null
+++ b/.dir-locals.el
@@ -0,0 +1,5 @@
+;;; Directory Local Variables
+;;; For more information see (info "(emacs) Directory Variables")
+
+((emacs-lisp-mode
+  (indent-tabs-mode . nil)))
diff --git a/README.md b/README.md
index a43b9d7..572459d 100644
--- a/README.md
+++ b/README.md
@@ -63,3 +63,19 @@ Ivy and Swiper wiki is here: [the 
wiki](https://github.com/abo-abo/swiper/wiki).
 (global-set-key (kbd "C-x l") 'counsel-locate)
 (global-set-key (kbd "C-S-o") 'counsel-rhythmbox)
 ```
+
+## Contributing
+
+### Copyright Assignment
+
+Swiper is subject to the same [copyright 
assignment](http://www.gnu.org/prep/maintain/html_node/Copyright-Papers.html) 
policy as Emacs itself, org-mode, CEDET and other packages in [GNU 
ELPA](http://elpa.gnu.org/packages/). Any [legally 
significant](http://www.gnu.org/prep/maintain/html_node/Legally-Significant.html#Legally-Significant)
 contributions can only be accepted after the author has completed their 
paperwork. Please see [the request 
form](http://git.savannah.gnu.org/cgit/gnulib. [...]
+
+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), and wait for some time 
(in my case, I had to wait for one month).
+
+### Style
+
+The basic code style guide is to use `(setq indent-tabs-mode nil)`. It is 
provided for you in 
[.dir-locals.el](https://github.com/abo-abo/swiper/blob/master/.dir-locals.el), 
please obey it.
+
+Before submitting the change, run `make compile` and `make test` to make sure 
that it doesn't introduce new compile warnings or test failures. Also run 
<kbd>M-x</kbd> `checkdoc` to see that your changes obey the documentation 
guidelines.
+
+Use your own judgment for the commit messages, I recommend a verbose style 
using `magit-commit-add-log`.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]