Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.64 KB
Raw

Contributor guidelines

Before you start

LSP is a universal language server package. It is not the place for language-specific logic, features or workarounds.

Sublime Text is not an IDE. Sublime Text users may appreciate IDE-like features, but a significant number of users will want to turn these features off due to performance or to keep the package "out of the way".

Please feel free to create an issue before coding:

  • If you are unsure your proposal is suitable
  • If you are unsure your solution will be technically sound

The issues also allow you to gather some feedback and help from other contributors.

Coding

Sublime Text 3 bundles a Python 3.3, please be sure to set up your environment to match. LSP uses flake8 and mypy to provide some code quality assurances. Run tox to check your work. Consider using LSP-pyright or pyls as a language server. To reload the plugin, save the file boot.py. Saving any other file does not reload the plugin.

Testing

Please consider testing your work with other language servers, even if you do not use them. There is also a test suite in tests/. To run the tests, use the UnitTesting package from randy3k. The configuration file for the tests is in unittesting.json.

Submitting

Before you submit your pull request, please review the following:

  • Any unrelated changes in there?
  • Is it a bug fix? Please link the issue or attach repro, logs, screenshots etc.
  • Is it a feature? Please attach screenshots / GIFs for visual changes.

I will try to help you get the PR in mergeable shape within a reasonable time, but it may take a few days. It is best if you check your GitHub notifications in the meantime!