Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 2.68 KB
Raw

Before creating a new issue

  • This tracker is for issues with the Sublime Text Core only.

    This includes packages providing core functionality, such as Default or Color Scheme - Default, but excludes packages providing support for syntaxes/languages.

    For language-specific issues with the "Default Language Packages" (which handle syntax highlighting and other language-related things), refer to the Default Language Packages repository.

    For issues related to other packages, head over to the respective repository or contact its author. Start with a clean profile if you need to verify.

  • Search for the issue here to check if it was already reported. You may use labels for filtering the issue list by clicking any of these related to the problem you want to report or request.

Filing a bug

  1. Start with a descriptive but concise subject that quickly and uniquely identifies the problem.

  2. Write a summary of the problem in a few lines, giving an idea of what the issue is about.

  3. Then, describe the bug with all the information you can give. Be sure to include the following information:

    • Operating System
    • The version of Sublime Text that you're using
    • Any related software which may cause ST to act strangely

    Also keep in mind to clearly separate fact from speculation.

  4. Try to find a way to reproduce the problem and write down precise steps. It might be useful to include a code example for this. if a specific code produces the bug, try to share the code

  5. Workarounds or other related tips on how to avoid the issue are welcome.

We won't slaughter you if you can't fulfill all of these steps but prepare to answer a few question if we think we're lacking information.

If you want to be really good at reporting bugs you can also read these guidelines for bugzilla bugs.

Filing an enhancement or a feature request

  1. Start with a descriptive but concise subject that quickly and uniquely identifies the issue.
  2. Explain briefly what the enhancement is and why you think it would be useful.
  3. Provide any other necessary or useful information regarding your issue, such as (code) examples or related links.

Note: "enhancements" are modifications to existing behavior as opposed to something entirely new.

This is a bug tracker run by the community. For the initial idea, read this forum thread: http://www.sublimetext.com/forum/viewtopic.php?f=2&t=12095.