Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 2.46 KB

README.md

File metadata and controls

38 lines (27 loc) · 2.46 KB
Raw

package.json research

Goal

A research analysis on the usage of package.json throughout the entire JavaScript ecosystem.

Research/Contribution Process

Contributions welcome! Reach out in the Slack channel for help!

Within the research directory are a collection of markdown files each containing the analysis for one or more top-level package.json properties. The file, package-json.md, contains a property research index.

Research should primarily focus on a property's existing rule-set and use-cases. Details should be presented in such a way to not infer bias to any single tool; however, since many tools share the same behavior, those details can be presented as fact.

For example, the dependencies property has a number of ways a dependency can be specified. From using SemVer, workspace syntax, or even specifying a git link, many package manager tools will resolve the value in a similar way (though the lockfile output may be unique).

Research should accurately and clearly declare when it is presenting tool-specific behavior about a certain package.json property.

Contributing New Research:

  • Make sure that an analysis has not already been conducted on the property or properties you are analyzing.
    • Check the index in package-json.md.
    • Check in progress pull requests.
      • If a PR seems stale, politely reach out to the author on the PR or within the Slack channel.
  • Open a draft PR including the following details:
    • Create a new file for your research in the research directory.
      • The file title should be short and representative of the property or properties being analyzed.
      • The file title should use kebab-case.
    • Add the property or properties and the new file to the index in package-json.md.
      • Use reference links so they can be reused throughout the file reliably.
    • The PR title should follow the format: Property: <property> or Properties: <property-1>, <property-2>.
    • The PR should have the label research (if you cannot add labels a contributor will)
  • Once your research is complete, mark the PR as "ready to review".

Contributing to Existing Research:

  • Open a PR with the title [research] Edit: <file-name.md>.