Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

68 lines (42 loc) · 1.71 KB
Raw

Contributing to Nx Console

We would love for you to contribute to Nx Console! Read this document to see how to do it.

Got a Question?

We are trying to keep GitHub issues for bug reports and feature requests. Stack Overflow is a much better place to ask general questions about how to use Nx Console.

Building the VSCode Plugin

You can build the vscode extension and run it in development mode by opening up this repo in Visual Studio code and hitting the f5 function key. This will launch nps prepare.dev.vscode in the background and spawn an extension development host version of VSCode so that you can try out your code.

When you want to update the extension with a new set of changes, go back to the editor you launched the extension host from and click the refresh button (its green and looks like a browser refresh icon).

Running Unit Tests

  • Run nps test to run unit tests.

Running Storybook

  • Run nps storybook to launch the storybook instance
  • Run nps storybook-e2e to run the e2e tests on the storybook instance

Submitting a PR

Please follow the following guidelines:

Run the following commands to make sure the linting and the tests pass.

  • nps format.check
  • nps lint
  • nps test

If nps format.check fails, run nps format.

Commit Message Guidelines

Commit message should follow the following format:

type: subject
BLANK LINE
body

Type

The type must be one of the following:

  • build
  • feat
  • fix
  • refactor
  • style
  • docs
  • test

Subject

The subject must contain a description of the change.

Example

feat: add links to angular.io to the generate screen

The generate screen shows links to docs explaining all command-line options in depth