@runtimed/jmp/CONTRIBUTING.md

Node.js module for creating, parsing and replying to messages of the Jupyter Messaging Protocol (JMP)

# Contributing to `jmp`

First of all, thank you for taking the time to contribute.

Here, you will find relevant information for contributing to this project.

## Issue tracker

Please, feel free to use the [issue
tracker](https://github.com/n-riesco/jmp/issues) to report any problems
you encounter or any enhancements you would like to see implemented. To
facilitate the process of fixing a problem, please, include the following
information in your report:

- `jmp` version. Please, run the command:

```sh
npm list jmp
```

- npm version:

```sh
npm version
```

- IPython version:

```sh
ipython --version
```

- Operating system. In most modern linux distributions, it is enough to run:

```sh
lsb_release -sd
```

## Code contributions

- Please, open an issue in the [issue
  tracker](https://github.com/n-riesco/jmp/issues).

- Pull requests will be distributed under the terms in the LICENSE file. Hence,
  before accepting any pull requests, it is important that the copyright holder
  of a pull request acknowledges their consent. To express this consent, please,
  ensure the AUTHORS file has been updated accordingly.

## Coding guidelines

- For the sake of readability, please, ensure the coding style of your pull
  requests is consistent with this project: lowerCamelCaseNaming,
  CONSTANTS_NAMING, 4-space indent, collapsed brackets...

- The IPython protocol uses underscores (`_`) in their the naming convention (as
  recommended in [PEP8](https://www.python.org/dev/peps/pep-0008/)). For these
  names, I find more readable to keep the original naming (although, if possible
  limited to a local scope).

- The source code in `jmp` is annotated using
  [JSDoc](https://github.com/jsdoc3/jsdoc). Running the command:

  ```sh
  npm run doc
  ```
  will generate the JSDoc documentation in folder `doc`.