Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

67 lines (47 loc) · 2.12 KB
Raw

Contributing to IJavascript

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 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:

  • IJavascript version. Please, run the command:
npm list ijavascript
  • npm version:
npm version
  • IPython version:
ipython --version
  • Operating system. In most modern linux distributions, it is enough to run:
lsb_release -sd

Code contributions

  • Please, open an issue in the issue tracker.

  • 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.

  • New functionalities should be documented, for this you can create tutorials as markdown or ipython notebook format in the folder doc/md or doc/ipynb. Then add a link to this tutorial in the _navbar.tpl jinja template and regenerate the doc with npm run doc to see the result.

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). For these names, I find more readable to keep the original naming (although, if possible limited to a local scope).

  • The source code in IJavascript is annotated using JSDoc. The generated documentation can be found here.