Thank you for deciding to contribute to the development of the VSCode Elements.
If you don’t feel confident enough to submit code changes, you can still contribute. Did you find a typo, grammatical error, or unclear documentation? Improving the documentation is a valuable contribution as well.
If you’re not yet familiar with the code, we recommend tasks labeled as “good first issue”. These tasks are relatively simple but still important to complete.
If you decide to work on an issue, please indicate it on the issue page to avoid duplication of work.
When submitting a bug report, aim to create a minimal reproducible example. It’s perfectly fine if the example is a repository with multiple files, as long as it can be started with a few simple commands (e.g., npm install && npm run dev).
It’s even better if you create a demo HTML file under the dev directory, using this as a starting point.
Install the dependencies with npm ci and start the development server using npm run start. Finally, attach the demo HTML file to your issue ticket.
Before submitting a pull request, ensure the code follows the styling guidelines and is well-formatted. It’s easier than it sounds—just use the lint and Prettier scripts (see the README). Writing tests is not required, but we appreciate it if you add tests for new code. If your changes affect the user-facing functionality, please update the changelog file.
Commit messages aim to follow the 50/72 style.