Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 3.09 KB

README.md

File metadata and controls

72 lines (45 loc) · 3.09 KB
Raw

Sublime Packages

Requirements

These packages are developed against the latest build of Sublime Text in the dev channel.

The latest release of Packages shipped with Sublime Text should be tagged via git in this repository, you can find a list at https://github.com/sublimehq/Packages/tags.

Bugs may exist on older builds, and the format used is not compatible with builds older than Build 4095.

Installation

To make changes to these packages and test them locally, fork this repository. Then symlink the changed packages into your Packages folder. (Replace Python in the following commands with the name of the syntax to install.)

OS X

$ git clone https://github.com/sublimehq/Packages.git
$ ln -s `pwd`/Packages/Python ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/

Linux

$ git clone https://github.com/sublimehq/Packages.git
$ ln -s `pwd`/Packages/Python ~/.config/sublime-text-3/Packages/

Windows

On Windows, you can use directory junctions instead of symlinks (symlinks require administrative rights; directory junctions don't):

# Using PowerShell
PS> git clone https://github.com/sublimehq/Packages.git
PS> cmd /c mklink /J "$env:APPDATA/Sublime Text 3/Packages/Python" (convert-path ./Packages/Python)

Alternatively, download the portable version and clone this repository directly as a subdirectory of the Data folder.

⚠️ Things to keep in mind

After you've finished, keep in mind that you're now overriding a default package. If other people make upstream changes to an overridden package, yours will be out-of-date when Sublime Text updates to a new version. To get the latest version, pull the changes from this repository.

Reference

Please refer to the official documentation:

Pull Requests

Pull requests should:

  1. Start with the name of the package in square brackets, e.g. [XML].
  2. Be as small and self-contained as is reasonable. Smaller changes are quicker to review.
  3. Include a new (or enhanced) syntax test when changing a .sublime-syntax file.
  4. Have multiple syntax tests and a set of performance measurements (old vs. new) when making significant changes.

New Packages

Pull requests for new packages won't be accepted at this stage, as new packages can cause issues for users who have a package with the same name installed via Package Control. There are some planned changes that will address this in the future.

Complex plugins such as auto complete systems and linters should generally be in a stand-alone package, rather than included in the default set of packages.

Missing Packages

This repository only contains syntax-definition-focused packages. Notably, packages such as Default and Theme - Default are not included.