Skip to content

Commit 3200566

Browse files
author
Ethan Arrowood
committed
init commit
0 parents  commit 3200566

File tree

3 files changed

+49
-0
lines changed

3 files changed

+49
-0
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# package.json Research Hub
2+
3+
## Goal
4+
5+
A research analysis on the usage of `package.json` throughout the entire JavaScript ecosystem.
6+
7+
## Research/Contribution Process
8+
9+
> Contributions welcome! Reach out in the [Slack channel][slack-channel] for help!
10+
11+
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.
12+
13+
To contribute new research:
14+
- Make sure that an analysis has not already been conducted on the property or properties you are analyzing.
15+
- Check the index in [package-json.md][package-json].
16+
- Check in progress pull requests.
17+
- If a PR seems stale, politely reach out to the author on the PR or within the [Slack channel][slack-channel].
18+
- Open a draft PR including the following details:
19+
- Create a new file for your research in the `research` directory.
20+
- The file title should be short and representative of the property or properties being analyzed.
21+
- The file title should use [kebab-case](https://www.freecodecamp.org/news/programming-naming-conventions-explained/#what-is-kebab-case).
22+
- Add the property or properties and the new file to the index in [package-json.md][package-json].
23+
- Use reference links so they can be reused throughout the file reliably.
24+
- The PR title should follow the format: `[research] Property: <property>` or `[research] Properties: <property-1>, <property-2>`.
25+
- Once your research is complete, mark the PR as "ready to review".
26+
27+
To contribute to existing research:
28+
- Open a PR with the title `[research] Edit: <file-name.md>`.
29+
30+
[package-json]: <./research/package-json.md>
31+
[slack-channel]: <https://openjs-foundation.slack.com/archives/C05AWQH5E4R>

research/dependencies.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Dependencies
2+
3+
Analysis of the following properties:
4+
- `"dependencies"`
5+
- `"devDependencies"`
6+
- `"peerDependencies"`
7+
8+
## Analysis
9+
10+
> TODO

research/package-json.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# package.json Analysis
2+
3+
## Property Research Directory
4+
- [`"dependencies"`][dependencies]
5+
- [`"devDependencies"`][dependencies]
6+
- [`"peerDependencies"`][dependencies]
7+
8+
[dependencies]: <./dependencies.md> "Dependencies"

0 commit comments

Comments
 (0)