Skip to content

Latest commit

 

History

History
191 lines (136 loc) · 9.29 KB

CONTRIBUTING.md

File metadata and controls

191 lines (136 loc) · 9.29 KB
Raw

npm CLI Contributor Roles and Responsibilities

Table of Contents

Introduction

Welcome to the npm CLI Contributor Guide! This document outlines the npm CLI repository's process for community interaction and contribution. This includes the issue tracker, pull requests, wiki pages, and, to a certain extent, outside communication in the context of the npm CLI. This is an entry point for anyone wishing to contribute their time and effort to making npm a better tool for the JavaScript community!

All interactions in the npm repository are covered by the npm Code of Conduct

Code Structure

/
├── bin/
│   │                  # Directory for executable files. It's very rare that you
│   │                  # will need to update a file in this directory.
│   │
│   ├── npm               # npm-cli entrypoint for bourne shell
│   ├── npm-cli.js        # npm-cli entrypoint for node
│   ├── npm.cmd           # npm-cli entrypoint for windows
│   ├── npx               # npx entrypoint for bourne shell
│   ├── npx-cli.js        # npx entrypoint for node
│   └── npx.cmd           # npx entrypoint for windows
│
├── docs/  📖
│   │                  # Directory that contains the documentation website for
│   │                  # the npm-cli. You can run this website locally, and have
│   │                  # offline docs! 🔥📖🤓
│   │
│   ├── content/          # Markdown files for site content
│   ├── src/              # Source files for the website; gatsby related
│   └── package.json      # Site manifest; scripts and dependencies
│
├── lib/  📦
│                      # All the Good Bits(tm) of the CLI project live here
│
├── node_modules/  🔋
│                      # Vendored dependencies for the CLI project (See the
│                      # dependencies section below for more details).
│
├── scripts/  📜
│                      # We've created some helper scripts for working with the
│                      # CLI project, specifically around managing our vendored
│                      # dependencies, merging in pull-requests, and publishing
│                      # releases.
│
├── test/  🧪
│                      # All the tests for the CLI live in this folder. We've
│                      # got a lot of tests 🤓🧪🩺
│
├── CONTRIBUTING.md       # This file! 🎉
└── package.json          # The projects main manifest file 📃

Running Tests

# Make sure you install the dependencies first before running tests.
$ npm install

# Run tests for the CLI (it could take a while).
$ npm run test

Debugging

It can be tricky to track down issues in the CLI. It's a large code base that has been evolving for over a decade. There is a handy make command that will connect the cloned repository you have on your machine with the global command, so you can add console.log statements or debug any other way you feel most comfortable with.

# Clone the repository to start with
$ git clone git@github.com:npm/cli.git

# Change working directories into the repository
$ cd cli

# Make sure you have the latest code (if that's what you're trying to debug)
$ git fetch origin latest

# Connect repository to the global namespace
$ make link

#################
# ALTERNATIVELY
#################
# If you're working on a feature or bug, you can run the same command on your
# working branch and link that code.

# Create new branch to work from (there are many ways)
$ git checkout -b feature/awesome-feature

# Connect repository to global namespace
$ make link

Coverage

We try and make sure that each new feature or bug fix has tests to go along with them in order to keep code coverages consistent and increasing. We are actively striving for 100% code coverage!

# You can run the following command to find out coverage
$ npm run test-coverage

Benchmarking

We often want to know if the bug we've fixed for the feature we've added has any sort of performance impact. We've created a benchmark suite to run against the CLI project from pull-requests. If you would like to know if there are any performance impacts to the work you're contributing, simply do the following:

  1. Make a pull-request against this repository
  2. Add the following comment to the pull-request: "test this please ✅"

This will trigger the benchmark suite to run against your pull-request, and when it's finished running it will post a comment on your pull-request just like below. You'll be able to see the results from the suite inline in your pull-request.

You'll notice that the bot-user will also add a 🚀 reaction to your comment to let you know that it's sent the request to start the benchmark suite.

image

If you've updated your pull-request and you'd like to run the the benchmark suite again, simple update your original comment, by adding test this please ✅ again, or simply just adding another emoji to the end. (The trigger is the phrase "test this please ✅" at the beginning of a comment. Updates will trigger as well, so long as the phrase stays at the beginning.).

image

Types of Contributions

Contributing an Issue?

Great!! Is your new issue a bug, a feature, or a question?

Contributing a Question?

Huh? 🤔 Got a situation you're not sure about?! Perfect! We've got some resources you can use.

  • Our documentation site

  • The local docs that come with the CLI project

    Example: npm help install --viewer browser

  • The man pages that are built and shipped with the CLI

    Example: man npm-install (only on linux/macOS)

  • Search of the current issues

Contributing a Bug Fix?

We'd be happy to triage and help! Head over to the issues and create a new one!

We'll need a little bit of information about what happened, rather than "it broke". Such as:

  • When did/does this bug happen?
  • Can you reproduce it? (Can you make it happen more than once.)
  • What version of node/npm are you running on your computer?
  • What did you expect it to do?
  • What did it _actually do?
  • etc...

Contributing a Feature?

Snazzy, we're always up for fancy new things! If the feature is fairly minor, the team can triage it and prioritize it into our backlog. However, if the feature is a little more complex, then it's best to create an RFC in our RFC repository. Exactly how to do that is outlined in that repository. If you're not sure exactly how to implement your idea, or don't want to make a document about your idea, then please create an issue on that repository. We consider these RRFC's, or a "Requesting Request For Comment".

Development Dependencies

You'll need a few things installed in order to update and test the CLI project during development:

  • node v8 or greater

We recommend that you have a node version manager installed if you plan on fixing bugs that might be present in a specific version of node. With a version manager you can easily switch versions of node and test if your changes to the CLI project are working.

Dependencies

Package vendoring is commonly referred to as the case where dependent packages are stored in the same place as your project. That usually means you dependencies are checked into your source management system, such as Git.

The CLI project vendors its dependencies in the node_modules/ folder. Meaning all the dependencies that the CLI project uses are contained within the project itself. This is represented by the bundledDependencies section in the root level package.json file. The main reason for this is because the npm CLI project is distributed with the NodeJS runtime and needs to work out of the box, which means all dependencies need to be available after the runtime is installed.

There are a couple scripts created to help manage this process in the scripts/ folder.