Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 3.8 KB

CONTRIBUTING.md

File metadata and controls

95 lines (67 loc) · 3.8 KB
Raw

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

We welcome contributions of any kind including documentation, organization, tutorials, bug reports, issues, feature requests, feature implementations, pull requests, answering questions on the mailing list, helping to manage issues, etc.

Asking Support Questions

We use mailing list [email protected] where users and developers can ask questions. Please don't use the GitHub issue tracker to ask questions.

Reporting Issues

If you believe you have found an issue, please use the GitHub issue tracker to report the Problem. If you're not sure if it's a bug or not, start by asking on the mailing list [email protected].

Building the extension

Install dependencies:

npm install

Create package:

vsce package

Pull Requests

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change and remember to add tests (if possible)
  4. Build the project locally and run local tests (if there are any)
  5. Push to your fork and submit a pull request
  6. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Format your code.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, submit them as separate pull requests.
  • Write good commit messages.

Release the extension

  1. When releasing the extension, don't forget to create a git tag with the version number and update this version number in the file package.json.
  2. Run vsce package to create a vsix file.
  3. Log into the marketplace
  4. Click on "Publish extensions"
  5. Click on "..." behing the extension name and choose "Update"

Issue and Pull Request Labels

Labels help us track and manage issues and pull requests.

Label Name Description
enhancement search Feature Requests
bug [search][search-label-bug] Something isn't working
duplicate search This issue or pull request already exists
good first issue search Good for newcomers
help wanted search Extra attention is needed
invalid search This doesn't seem right
question search Further information is requested
wontfix search This will not be worked on

Resources