Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 2.24 KB
Raw

CONTRIBUTING

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Setup

Install Node.js 8+ on your system: https://nodejs.org/en/download/

  1. Clone down the repo
$ git clone git@github.com:netlify/cli.git
  1. Install dependencies
$ npm install
  1. Run CLI locally during development
$ ./bin/run [command]

When developing, you can use watch mode which will automatically run ava tests:

$ npm run watch

Architecture

The CLI is written using the oclif cli framework and the netlify/js-client open-api derived API client.

  • Commands live in the src/commands folder.
  • The base command class which provides consistent config loading and an API client lives in src/base.
  • Small utilities and other functionality live in src/utils.

A good place to start is reading the base command README and looking at the commands folder.

Testing

This repo uses ava for testing. Any files in the src directory that have a .test.js file extension are automatically detected and run as tests.

We also test for a few other things:

  • Dependencies (used an unused)
  • Linting
  • Test coverage
  • Must work with Windows + Unix environments.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.

Releasing

  1. Clean out local node_modules. rm -rf node_modules. This is to counteract any oddities that may arise during the shrinkwrap process that happens when cli is released.
  2. Install dependencies. npm install.
  3. npm version [major, minor, patch] Generate changelog and bump version.
  4. npm publish Publish to npm, push version commit + tag, push latest CHANGELOG entry to GitHub release page.

License

By contributing to Netlify Node Client, you agree that your contributions will be licensed under its MIT license.