Skip to content

Latest commit

 

History

History
140 lines (94 loc) · 5.03 KB

CONTRIBUTING.md

File metadata and controls

140 lines (94 loc) · 5.03 KB
Raw

Contribution Guide

This is the common top level contribution guide for this mono-repo. A sub-package may have an additional CONTRIBUTING.md file if needed.

Legal

All contributors must sign the DCO

This is managed automatically via https://cla-assistant.io/ pull request voter.

Development Environment

pre-requisites

  • Yarn >= 1.4.2
  • A maintained version of node.js
    • This package is targeted and tested on modern/supported versions of node.js only. Which means 8/10/12/13 at the time of writing this document.
  • commitizen for managing commit messages.

Initial Setup

The initial setup is trivial:

  • clone this repo
  • yarn

Committing Changes

Use git cz to build conventional commit messages.

Formatting.

Prettier is used to ensure consistent code formatting in this repository. This is normally transparent as it automatically activated in a pre-commit hook using lint-staged. However this does mean that dev flows that do not use a full dev env (e.g editing directly on github) may result in voter failures due to formatting errors.

Compiling

TypeScript is the main programming language used in this mono-repo.

Use the following npm scripts at the repo's root to compile all the sub-packages productive (excluding tests) source code:

  • yarn compile
  • yarn compile:watch (will watch files for changes and re-compile as needed)

These commands are also available in each sub-package. However it is recommended to use the top level scripts to avoid forgetting to (re-)compile a sub-package's dependency.

Testing

Jest is used for unit-testing and coverage reports and Istanbul/Nyc is used to collect integrated coverage report.

  • To run the tests run yarn test in either the top level package or a specific subpackage.
  • To run the tests with a coverage report run yarn coverage in either the top level package or a specific subpackage.

Debugging

In IntelliJ

Open the package.json file of the package and debug the test script. It will stop in breakpoints you set in the TypeScript code.

In VS Code:

To debug tests in VS Code, in the root launch.json file, add a Node.js: Jest Tests configuration by using code assist. Change the following in the added configuration:

  • Change tdd to bdd under the args property
  • Add a cwd property that points to the package root folder, for example (for language-server package): "cwd": "${workspaceFolder}/packages/language-server",
  • Optionally add the package name to the name property

The result should look similar to this:

{
  "type": "node",
  "request": "launch",
  "name": "language-server Jest Tests",
  "program": "${workspaceFolder}/node_modules/.bin/jest",
  "args": [
    "-u",
    "bdd",
    "--timeout",
    "999999",
    "--colors",
    "${workspaceFolder}/test"
  ],
  "cwd": "${workspaceFolder}/packages/language-server",
  "internalConsoleOptions": "openOnSessionStart",
  "skipFiles": ["<node_internals>/**"]
}

When running this launch configuration in VS Code, it will stop on breakpoints you set in the TypeScript code.

Test Coverage

At least 90%* Test Coverage is enforced for all productive code in this mono repo.

  • Specific statements/functions may be excluded from the report but the reason for that must specified in the source code.

Full Build

To run the full Continuous Integration build run yarn ci in in either the top level package or a specific subpackage.

Release Life-Cycle.

This monorepo uses Lerna's independent mode support a separate life-cycle (version number) for each package and automatically generate the changelog by adhering to Conventional Commits

Release Process

Performing a release requires push permissions to the repository.

  • Ensure you are on master branch and synced with origin.
  • yarn run release:version
  • Follow the lerna CLI instructions.
  • Track the new /v\d+.\d+.\d+/ tag build on circle-ci.
  • Once the tag builds have successfully finished:
    • Inspect the npm registry to see the new sub packages versions.
    • Inspect the new github release named after the new /v\d+.\d+.\d+/ tag and verify it contains the .vsix artifact.