Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add more details regarding research process #7

Merged
merged 2 commits into from
Jan 12, 2024
Merged

Add more details regarding research process #7

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af700b3
add more details regarding research process
Sep 13, 2023
324cfcc
adjust section based on recent meeting discussions
Ethan-Arrowood Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ A research analysis on the usage of `package.json` throughout the entire JavaScr

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][package-json], contains a property research index.

To contribute new research:
Research should primarily focus on documenting the rules of a property's value. The analysis should avoid details regarding _how_ the value will be used by various tools. For example, the `dependencies` property has a number of ways a dependency can be included. Beyond the standard SemVer value, some tools also allow for various workspace specific syntax. The research for this property should include details regarding all the different ways a dependency could be listed, but not how a tool will necessarily resolve the dependency.
Ethan-Arrowood marked this conversation as resolved.
Show resolved Hide resolved

### 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][package-json].
- Check in progress pull requests.
Expand All @@ -24,7 +26,7 @@ To contribute new research:
- The PR title should follow the format: `[research] Property: <property>` or `[research] Properties: <property-1>, <property-2>`.
- Once your research is complete, mark the PR as "ready to review".

To contribute to existing research:
### Contributing to Existing Research:
- Open a PR with the title `[research] Edit: <file-name.md>`.

[package-json]: <./research/package-json.md>
Expand Down