I've been introducing tons of people to Spacemacs, and most of them
always think that having to read documentation in how to add a layer is
too much.
I made this modification to make it easier to install layers.
This commit merge the `CONTRIBUTING.md` and `doc/CONTRIBUTE.org` file
into a new `CONTRIBUTING.org` file. It also refactors the content to be
more organized and make its navigation more goal-oriented.
Github displays a link to the `CONTRIBUTING.*` file when people are
opening new issues or proposing new PRs. This file is important because
it is the entry-point to contributions guidelines for most of the users.
The current setup is non-optimal, even broken, as it adds a level of
indirection, and points to a contributing file that has broken
links (due to the new documentation format). The possible drawback of
the proposed solution is that I'm not sure if it is possible to include
it into the new online documentation as it is not in `doc/` folder.
The other possibility is to keep a small `CONTRIBUTING.md` file, as it
is now, pointing to the new documentation system (once online), but I'm
preferring the proposed solution for the following reasons:
- People that are willing to contribute will probably open Github
first (for forking, creating PR, etc), not the online documentation.
- It has one level of indirection less when people click on the
guidelines guide from a new issue/PR.
- `CONTRIBUTING.*` is by convention a special kind of file on github, so
it's valid reason to break the rule and not having it in the `doc/`
folder.
The current way to highlight TODOs is `spacemacs/highlight-TODO-words`
which is a spacemacs' hard-coded function.
This commit changes it for the `hl-todo` package. This imply:
- More keywords are supported out of the box.
- Keywords are associated to faces, so they are shown in different
colors.
- Keywords are stored with their faces in a list, so it's easier for
users to add their own keywords and faces (as contrary to a regexp).
- It is possible to disable highlighting by simply excluding the
package.
This pre-command-hook translates the special key to the corresponding
emacs function key. This effects only happens in terminal, this hook is
a no-op in GUI.
By doing this we attempt to bring more consistency between the GUI
and the terminal regarding TAB and RET keys.
spacemacs/set-key
spacemacs/set-key-for-state
These functions find normalized keys which should handle as sanely as
possible the GUI and the terminal.
See docstring of spacemacs//normalize-key for more info.
This commit changes:
<leader> a p from proced to list-processes
<leader> a P from paradox-list-packages to proced
and <leader> a k to paradox-list-packages.
