Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

66 lines (48 loc) · 1.79 KB
Raw

Contributing to ITypescript

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:

  • ITypescript version. Please, run the command:
its --version
  • npm version:
npm version
  • IPython/Jupyter version:
ipython --version
jupyter --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.

Coding guidelines

  • For the sake of readability, please, ensure the coding style of your pull requests is consistent with this project. You can check whether your code meets our convention by the following shell code.

    npm run lint

    If you want not only to check the convention but also to compile TypeScript file:

    npm run tsc

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