apache / apache/cordova-docs

Document package.json fields in the reference

Open
#1,005 6 comments 2 reactions 0 assignees View on GitHub
bug help wanted
Dominant language
JavaScript
Stars
353
Forks
565
Avg merge
7h 15m
Merged PRs (30d)
5

Description

I can see how there is a reference page for `config.xml` but don’t see a corresponding reference page for `package.json`. I think the reference page for Cordova-specific `package.json` fields is needed.

I also think that how and when the Cordova CLI would update each of the fields in `package.json` is needed, just like this was already done for `config.xml`.

This issue is triggered by #1004 (deprecated plugins element in `config.xml`).

Contributor guide

Open the contributing guide

Research direction

Start by comparing the existing config.xml reference page with the Cordova-specific fields in package.json and the documented Cordova CLI behavior. Document each relevant package.json field and explain how and when the CLI updates it, matching the coverage already provided for config.xml.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.