Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 2.51 KB
Raw

How to contribute

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved!

Using the issue tracker

Use the issues tracker for:

Bug reports

A bug is either a demonstrable problem that is caused in extension failing to provide the expected feature or indicate missing, unclear, or misleading documentation. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the main branch in the repository.

  3. Isolate and report the problem — ideally create a reduced test case.

Please try to be as detailed as possible in your report. Include information about version of the VSCode and extension. Please provide steps to reproduce the issue as well as the outcome you were expecting! All these details will help developers to fix any potential bugs.

Feature requests

Feature requests are welcome and should be discussed on issue tracker. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the community of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

IMPORTANT: By submitting a patch, you agree that your work will be licensed under the license used by the project.

If you have any large pull request in mind (e.g. implementing features, refactoring code, etc), please ask first otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding conventions in the project (indentation, accurate comments, etc.).

Release

  1. Update version in CHANGELOG.md and add notes
    1. If possible link the pull request of the changes and mention the author of the pull request
  2. Create new commit
    1. git add CHANGELOG.md
    2. git commit -m "changelog for v0.45.0"
  3. Make a new version tag (for example, v0.45.0)
    1. git tag v0.45.0
  4. Push changes to the repo.
    1. git push --atomic origin main v0.45.0