Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 1.64 KB

There are several sections. Choose one of them and follow the instructions.

Open an issue

Use this section if you want to open an issue describing a problem.

Please follow the instructions:

  • Check that there is no issue describing the problem
  • Fill the issue

Fix an opened issue

Use this section if you want to fix a problem or add a feature and there is an opened issue for that.

Please follow the instructions:

  • Choose an issue

  • Ensure the issue is not being done by someone else

  • Write a comment like "I will done it"

  • Write a solution

  • Open a pull request.

    In the pull request's description describe what is exactly done.

    Last line of the pull request should be "Fixed #{number of the issue}"

  • Wait until the pull request is merged

Fix a bug or add a feature

Use this section if you want to fix a problem or add a feature and there is no opened issue for that.

Please follow the instructions:

  • Create an issue. Describe it in detail.
  • If you are unsure about implementation discuss it in the issue
  • Follow the instructions from the section "Fix an opened issue"

Suggestion to add a feature or change behavior

Use this section if you have an idea, but you are unsure whether other people would like it.

Please follow the instructions:

  • Create an issue. Describe it in detail. Mark it with the "Question" label.
  • Discuss it

Instruction to be done before submitting a pull question

  • Execute npm run gulp in the root directory of the extension to compile the code and to check for code style violation
  • Launch tests:
    • Open the project in VSCode
    • Switch to Debug
    • Launch tests