CONTRIBUTING.rst 1.65 KB
Newer Older
HiPhish's avatar
HiPhish committed
1 2 3
###########################
 Contributing to REPL.nvim
###########################
4
.. default-role:: code
HiPhish's avatar
HiPhish committed
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


If you decide to contribute to the development of REPL.nvim please follow the
rules outlined in this file.


Project goals and non-goals
###########################

REPL.nvim aims to be a generic REPL plugin. We want to support as many REPL
types as possible, but we do not offer preferential treatment to any of them.
The main goal is to be a generic wrapper around Nvim‘s `:terminal` command.

Do:

- Add new REPL types

Do not:

- I don‘t know, this list will be filled out over time hopefully


Technical writing
#################

30
We use reStructuredText_ (reST) for documenting the project. Please follow these
HiPhish's avatar
HiPhish committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
guidelines:

- Use proper quotes:

  =====  ==================  =================================================
  Glyph  Unicode code point  Name
  =====  ==================  =================================================
  ``‘``  U+2018              Left single quotation mark
  ``’``  U+2019              Right single quotation mark
  ``“``  U+201C              Left double quotation mark
  ``”``  U+201D              Right double quotation mark
  =====  ==================  =================================================

  If you see wrong quotation marks (``'``, ``"``, ````` and ``´``) please fix
  them.

- Annotate the file in `HACKING.rst`_ using a field list:

  .. code-block:: rst

     About the `foo` function
     ########################
     :file: plugin/foo.vim

  This makes it easy for readers to jump directly to that file.


58
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
HiPhish's avatar
HiPhish committed
59
.. _HACKING.rst: HACKING.rst