Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

52 lines (36 loc) · 2.54 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 if 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 bundles a Python 3.3, please be sure to set up your environment to match. LSP uses LSP-pyright, flake8 and mypy to provide some code quality assurances. Run tox to check your work. Consider using LSP-pyright or LSP-pylsp 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.

We will try to help you get the PR in a 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!

Releasing a new version (for maintainers)

  • Get a log of commits since the previously released tag with git log --format="- %s (%an)" <previous_tag>..main
  • Filter out non-relevant and non-important commits (it's not relevant to report fixes for bugs that weren't released yet, for example)
  • Optionally group changes into Fixes/Features/etc.
  • Create a new file in messages/ with a file name of the yet-to-be-released version and include the changes.
  • Run ./scripts/release.py build which will bump the version and create a new commit with a new messages file included.
  • If something doesn't look right in the newly created commit, delete the newly created tag manually and git reset to the previous commit making sure that you don't lose the newly created messages file.
  • Run GITHUB_TOKEN=<your_token> ./scripts/release.py publish to push and create a new Github release.