branch: master
commit b1b29f0c76971934ea1a505e423b02c3b470b527
Author: Oleh Krehel <[email protected]>
Commit: Oleh Krehel <[email protected]>
CONTRIBUTING.org: Rename from CONTRIBUTING.md
Re #1260
---
CONTRIBUTING.md | 40 ----------------------------------------
CONTRIBUTING.org | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
targets/plain.el | 1 +
3 files changed, 53 insertions(+), 40 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index 551f644..0000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,40 +0,0 @@
-# Reporting issues
-
-Before reporting a bug, please take a look at the
[FAQ](https://github.com/abo-abo/swiper/blob/master/README.md), as well as the
[manual](http://oremacs.com/swiper/) and the
[wiki](https://github.com/abo-abo/swiper/wiki). Please also make sure that
there is not yet an existing issue.
-
-In order to fix it, we need to be able to reproduce the bug you encountered as
closely as possible, so please describe the problem in as much detail as
possible. It is important that we can rule out interference with other Emacs
packages or customisations, therefore use `emacs -Q` to bypass your init file.
Running `make plain` will start Emacs and load the packages for you. If you
want to sandbox your Emacs environment even further, use the shell code below.
-
-```
-$ emacs --version
-GNU Emacs 25.3.1
-$ cd /tmp
-$ git clone https://github.com/abo-abo/swiper.git
-$ cd swiper
-$ git log -1 --oneline
-3cd7637 ivy-overlay.el: Expect window to be 1 row taller
-$ HOME="$PWD" emacs -L .
-```
-
-You can use `eval-expression` to load swiper/ivy and counsel and continue from
there.
-
-```
-(require 'swiper)
-(ivy-mode 1)
-
-(require 'counsel)
-(counsel-mode 1)
-```
-
-# Contributing code
-
-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 a change, run `make compile` and `make test` to make sure
that it doesn't introduce new compilation warnings or cause tests to fail. Also
run `make checkdoc` to see that your changes obey 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](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/cgi [...]
-
-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).
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
new file mode 100644
index 0000000..9a7a823
--- /dev/null
+++ b/CONTRIBUTING.org
@@ -0,0 +1,52 @@
+* Reporting issues
+
+Before reporting a bug, please take a look at:
+- the [[https://github.com/abo-abo/swiper/blob/master/README.md][FAQ]]
+- the [[http://oremacs.com/swiper/][manual]]
+- the [[https://github.com/abo-abo/swiper/wiki][wiki]]
+- the [[https://github.com/abo-abo/swiper/issues][open issues]]
+
+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:
+#+begin_src sh
+git clone https://github.com/abo-abo/swiper/
+cd swiper
+make plain
+#+end_src
+
+* Contributing code
+The basic code style guide is to use:
+#+begin_src elisp
+(setq indent-tabs-mode nil)
+#+end_src
+It is provided for you in
[[https://github.com/abo-abo/swiper/blob/master/.dir-locals.el][.dir-locals.el]],
please obey it.
+
+Before submitting a change, run:
+- =make compile= - check for new compilation warnings
+- =make test= - check for failing tests
+- =make checkdock= - 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
[[http://www.gnu.org/prep/maintain/html_node/Copyright-Papers.html][Copyright
Assignment]] policy as
+Emacs itself, org-mode, CEDET and other packages in
[[http://elpa.gnu.org/packages/][GNU ELPA]].
+
+Any
[[http://www.gnu.org/prep/maintain/html_node/Legally-Significant.html#Legally-Significant][legally
significant]] contributions can only be accepted after the
+author has completed their paperwork. Please see
[[http://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/Copyright/request-assign.future][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)
diff --git a/targets/plain.el b/targets/plain.el
index d381390..b9b2120 100644
--- a/targets/plain.el
+++ b/targets/plain.el
@@ -1,3 +1,4 @@
(package-initialize)
(ivy-mode)
+(counsel-mode)
(setq enable-recursive-minibuffers t)
