Skip to content

Contributing

The package is still at work-in-progress stage. All comments and suggestions are most welcome!

Reporting issues

If anything does not work as expected, feel free to do not hesitate to open a new issue on GitHub. For first time GitHub users, see here. In your bug report, it's better to have:

  • A short and informative title

    ✅ “twsc” does not trigger scatter plot

    ❌ code snippet not working

  • A minimal and self-contained code/steps to reproduce the bug

    ✅ Type “twsc” and press Tab but nothing happens

    ❌ I use scatter plot snippet

  • The current outcome

    ✅ “twsc” + Tab gives “twsc    ” (twsc with four whitespaces)

    ❌ nothing happens

  • The expected outcome

    ✅ It should trigger https://github.com/harningle/StataEditor/blob/master/Twoway%20scatter.sublime-snippet

    ❌ a scatter plot template

  • Log

    ✅ Press Ctrl+`, and copy the entire console log

    ❌ Nothing happens so I have absolutely no idea

  • (Potential fix. If you have any idea to fix that, please tell me! You can open an issue and then a pull request)

Requesting snippets

If you have some frequently used code blocks and want to share with us, please check this and also open an issue (and create a PR if possible), with:

  • A concise title as above

  • A trigger

    ✅ Ideally the trigger is “merg”

    ❌ I want a code snippet for merge

  • A complete code block

    ✅ merge m:1 using "some_data.dta"

    ❌ It should give us Stata merge command

  • The placeholders

    ✅ In the above code, the “m”, “1”, and “some_data.dta” can be modified

    ❌ I want 1:1, 1:m, and m:1 mode

General questions

If you have any other questions, just open an issue!