Skip to content

Commit 6f7c892

Browse files
Add more details regarding research process (#7)
* add more details regarding research process * adjust section based on recent meeting discussions
1 parent 6cdbc62 commit 6f7c892

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@ A research analysis on the usage of `package.json` throughout the entire JavaScr
1010
1111
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.
1212

13-
To contribute new research:
13+
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.
14+
15+
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).
16+
17+
Research should accurately and clearly declare when it is presenting tool-specific behavior about a certain package.json property.
18+
19+
### Contributing New Research:
1420
- Make sure that an analysis has not already been conducted on the property or properties you are analyzing.
1521
- Check the index in [package-json.md][package-json].
1622
- Check in progress pull requests.
@@ -24,7 +30,7 @@ To contribute new research:
2430
- The PR title should follow the format: `[research] Property: <property>` or `[research] Properties: <property-1>, <property-2>`.
2531
- Once your research is complete, mark the PR as "ready to review".
2632

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

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

0 commit comments

Comments
 (0)