Skip to content

Latest commit

 

History

History
182 lines (154 loc) · 7.68 KB

CONTRIBUTING.md

File metadata and controls

182 lines (154 loc) · 7.68 KB
Raw

Contributing

Where to Begin

Development is based on milestones. Each milestone will be implemented in its own branch (e.g. branch v2.0.4).

The first thing you should do is determining the branch to base your edits on.

If you are fixing an issue that already exists in the issue tracker, see which milestone it belongs to and commit your contribution to the branch with the same name as the milestone. If the issue doesn't belong to a milestone;

  • push-access users: assign it to the closest milestone.
  • non-push-access users: pick the closest milestone.

If your contribution is independent from the issue tracker, pick the closest milestone and create your commits in that branch.

If the milestone branch doesn't exist yet;

  • push-access users: create it. The format is e.g. v2.0.4 and increments decimally. It is not semver.
  • non-push-access users: pick master branch.

After you've done with your commits;

  • push-access users: push your local branch to the same named branch on GitHub.
  • non-push-access users: send a pull request from your local branch to the same named branch on GitHub.

Each milestone will have a pull request that will be kept open until the milestone is completed. The purpose of this is having a showcase and discussion page for the milestone. You can describe there what you have implemented, preferably using screenshots. It's also an early feedback place for the users about your contribution.

General Guidelines

  • Code formatting:

    • Indentation: 4 spaces
    • Line endings: \n

  • If your contribution deserves a place in README.md, please do so. Preferably in the same commit with your modifications.

  • If you want to add screenshots to README.md, put your images under screenshots/ directory. For creating your screenshots, you can use markdown files under samples/ directory.

  • We create changelog files for Package Manager updates. They are under messages/ directory.

    If your contribution deserves a place under one of the "Bug Fixes", "New Features", "Changes" titles, please do so. Preferably in the same commit with your modifications.

    You have to edit the changelog that belongs to the branch you've worked on. For example, if you have based your commits on branch v2.0.4, then the changelog you should edit is messages/2.0.4.md.

    If the changelog file doesn't exist yet, create it by copying messages/template.md as a template.

  • If you are defining a new key binding, please define for all the 3 OSs in their own .sublime-keymap files. You have to insert your edits into the exacly same place in the 3 files.

  • If you want to introduce a new setting key for one of the .sublime-settings files, use mde. prefix in your setting key.

  • For testing your changes, you can use the test files under tests/. You can extend those files to add new tests and edge cases.

Publishing to Package Control

When the milestone is completed, push-access users can publish the new version to the Package Control. Creating the new version tag on the GitHub repository is enough for this. For example, if the name of the milestone is v2.0.4, the tag should be 2.0.4.

The update process may take up to an hour depending on the crawl frequency by the Package Control.

Contributing to themes

Here are the used scopes under 3 different markdown flavors. If you are not sure about how the scopes are used, checkout .tmlanguage files or ask in issues. Unique scopes are marked as bold.

ScopeName: text.html.markdown

  • constant.character.escape.markdown
  • constant.other.reference.link.markdown
  • invalid.illegal.whitespace.markdown
  • markup.bold.markdown
  • markup.bold_italic.markdown
  • markup.heading.1.markdown
  • markup.heading.2.markdown
  • markup.heading.markdown
  • markup.italic.markdown
  • markup.list.numbered.markdown
  • markup.list.unnumbered.markdown
  • markup.quote.markdown
  • markup.raw.block.markdown
  • markup.raw.inline.content.markdown
  • markup.raw.inline.markdown
  • markup.underline.link.image.markdown
  • markup.underline.link.markdown
  • meta.block-level.markdown
  • meta.disable-markdown
  • meta.dummy.line-break
  • meta.image.inline.markdown
  • meta.image.reference.markdown
  • meta.link.email.lt-gt.markdown
  • meta.link.inet.markdown
  • meta.link.inline.markdown
  • meta.link.reference.def.markdown
  • meta.link.reference.literal.markdown
  • meta.link.reference.markdown
  • meta.other.valid-ampersand.markdown
  • meta.other.valid-bracket.markdown
  • meta.paragraph.list.markdown
  • meta.paragraph.markdown
  • meta.separator.markdown
  • punctuation.definition.blockquote.markdown
  • punctuation.definition.bold.markdown
  • punctuation.definition.constant.begin.markdown
  • punctuation.definition.constant.end.markdown
  • punctuation.definition.constant.markdown
  • punctuation.definition.heading.markdown
  • punctuation.definition.italic.markdown
  • punctuation.definition.link.markdown
  • punctuation.definition.list_item.markdown
  • punctuation.definition.list_item.number.markdown
  • punctuation.definition.metadata.markdown
  • punctuation.definition.raw.markdown
  • punctuation.definition.string.begin.markdown
  • punctuation.definition.string.end.markdown
  • punctuation.definition.string.markdown
  • punctuation.separator.key-value.markdown
  • string.other.link.description.markdown
  • string.other.link.description.title.markdown
  • string.other.link.title.markdown

ScopeName: text.html.markdown.gfm

  • constant.character.escape.markdown
  • constant.other.reference.link.markdown
  • entity.name.tag.other.html
  • invalid.illegal.whitespace.markdown
  • markup.bold.markdown
  • markup.bold_italic.markdown
  • markup.heading.1.markdown
  • markup.heading.2.markdown
  • markup.heading.markdown
  • markup.italic.markdown
  • markup.kbd.content.markdown
  • markup.kbd.markdown
  • markup.list.numbered.markdown
  • markup.list.unnumbered.markdown
  • markup.quote.markdown
  • markup.raw.block.fenced.markdown
  • markup.raw.block.markdown
  • markup.raw.inline.content.markdown
  • markup.raw.inline.markdown
  • markup.strikethrough.markdown
  • markup.underline.link.image.markdown
  • markup.underline.link.markdown
  • meta.block-level.markdown
  • meta.disable-markdown
  • meta.dummy.line-break
  • meta.image.inline.markdown
  • meta.image.reference.markdown
  • meta.link.email.lt-gt.markdown
  • meta.link.inet.markdown
  • meta.link.inline.markdown
  • meta.link.reference.def.markdown
  • meta.link.reference.literal.markdown
  • meta.link.reference.markdown
  • meta.other.valid-ampersand.markdown
  • meta.other.valid-bracket.markdown
  • meta.paragraph.list.markdown
  • meta.paragraph.markdown
  • meta.separator.markdown
  • meta.tag.other.html
  • punctuation.definition.blockquote.markdown
  • punctuation.definition.bold.markdown
  • punctuation.definition.constant.begin.markdown
  • punctuation.definition.constant.end.markdown
  • punctuation.definition.constant.markdown
  • punctuation.definition.heading.markdown
  • punctuation.definition.italic.markdown
  • punctuation.definition.link.markdown
  • punctuation.definition.list_item.markdown
  • punctuation.definition.metadata.markdown
  • punctuation.definition.raw.markdown
  • punctuation.definition.strikethrough.markdown
  • punctuation.definition.string.begin.markdown
  • punctuation.definition.string.end.markdown
  • punctuation.definition.string.markdown
  • punctuation.definition.tag.begin.html
  • punctuation.definition.tag.end.html
  • punctuation.separator.key-value.markdown
  • string.other.link.description.markdown
  • string.other.link.description.title.markdown
  • string.other.link.title.markdown

ScopeName: text.html.markdown.multimarkdown

  • <All scopes under text.html.markdown.gfm>
  • keyword.other.multimarkdown
  • punctuation.separator.key-value.multimarkdown
  • meta.header.multimarkdown
  • string.unquoted.multimarkdown
  • meta.content.multimarkdown