Skip to content
This repository has been archived by the owner on Dec 6, 2021. It is now read-only.

Latest commit

 

History

History
43 lines (29 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 2.04 KB
Raw

Contributing to the Angular/Karma Test Explorer for Visual Studio Code

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

This repository contains the implementation for Angular/Karma Test Explorer extension that works with the Test Explorer UI extension.

Development

  • install the Test Explorer UI extension
  • fork and clone this repository and open it in VS Code
  • run npm install
  • run npm run watch or start the watch Task in VS Code
  • start the debugger (F5)

You should now see a second VS Code window, the Extension Development Host. Open a angular or karma project in this window and click the "Test" icon in the Activity bar. Now you should see the test suite in the side panel (angular projects take longer to load do to angular build times):

Example loaded suite

Making Changes

  • pick an existing bug or feature from the repository (or create your own).
  • create a new branch with a descriptive name, I suggest a prefix like feature/my-new-feature or bugfix/this-damm-bug.
  • make the code changes.
  • include unit tests (I am using jest) for any new functionality you submit.
  • create a pull request on the repository, please link the pull request to the feature or bug related to your changes.
  • include a summary of the changes you made in the pull request.

Verifying Before Submitting

  • run unit tests with npm run test and verify all existing functionality is still working.

Extra Guidelines

  • if it's a bugfix and tests exist for that module make sure the changes dont break them or that the bugfix is now covered by test cases.
  • make sure you have installed prettier and tslint and that all the code submitted is properly formatted.

Most important

Dont be shy, comment on the issue at hand so the community and I can give you a hand. If there is something you dont understand please ask, I am more than willing to help you.