mapbox / mapbox/mts-data-sync

Publish to NPM

Open
#12 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
71
Forks
15
PR merge metrics
No merged PRs in 30d

Description

The installation instructions for this utility seem odd relative to other Node-based utilities. Typically I'd expect to see something like

```
npm install -g mts-data-sync
```

To install a global utility, rather than cloning and linking. That would give the utility the benefit of only installing on tagged releases rather than whatever is in the main branch of the repository. Is there some reason why this repository uses a different technique?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the installation instructions and compare the current clone-and-link process with the proposed global npm installation. Check how tagged releases and npm publishing are handled in this repository; done means the supported installation method is decided and the instructions reflect it.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
cli, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.