From 3fa22687857670690e40342999fd9b4b405308c0 Mon Sep 17 00:00:00 2001 From: Alexander Karan Date: Thu, 15 Jan 2026 19:37:40 +0800 Subject: [PATCH 1/2] Initial Draft --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 27 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2b64b22 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing to Framework Tracker + +Framework Tracker is part of the e18e.dev community. Want to get involved head to our Discord at https://chat.e18e.dev. + +## Where to Start + +Framework Tracker has a few different areas where you can contribute to: + +- **Improving Metrics**: Suggest new metrics or improve the way we collect and display existing ones. +- **Documentation**: Enhance our documentation site by fixing typos, improving explanations, or adding new sections. UI/UX improvements are also welcome! +- **Adding New Frameworks**: Help us expand our list of tracked frameworks by adding new ones and gathering relevant metrics. Check out [initial-comparison-list.md](./initial-comparison-list.md#frameworks) for the list of currently tracked frameworks and metrics. Be careful when adding a new framework as in its current state adding a new framework adds to the maintenance burden. + +### How Metrics Work + +We currently run scripts into the CI to measure and collect metrics for each framework. Right now we measure each frameworks starter project. In our current pipeline there will be an option to re-implement the same App in each framework to measure certain metrics. (this is why each stats content in the Astro site has a type value of either "starter" or "app".) + +The current flow for collecting metrics is as follows: + +1. A PR is merged which triggers the CI Pipeline: `generate-stats` +2. The CI Pipeline runs and measures different metrics for each framework +3. The collected metrics are passed into the final step which runs the scripts in `stats-generator` +4. The `stats-generator` does some measure of its own and then create a content.json file for each framework in the Astro docs site. + diff --git a/README.md b/README.md index 84ecbcb..f72c72a 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ This project aims to provide objective, data-driven comparisons of meta-framewor See [initial-comparison-list.md](./initial-comparison-list.md) for the full list of frameworks we're tracking and the metrics we're measuring. +## Getting Involved + +We welcome contributions from the community! Whether you're interested in adding new frameworks, improving existing metrics, or enhancing the documentation site, your help is appreciated. Check out [CONTRIBUTING.md](./CONTRIBUTING.md) for more details on how to get started. + ## Project Structure This is a monorepo managed with pnpm workspaces: From 1e4c4289dec7286314f4becf533abaafb6ce67a0 Mon Sep 17 00:00:00 2001 From: Alexander Karan Date: Thu, 15 Jan 2026 19:44:16 +0800 Subject: [PATCH 2/2] Improvements --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b64b22..9f5c4d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,20 +4,22 @@ Framework Tracker is part of the e18e.dev community. Want to get involved head t ## Where to Start -Framework Tracker has a few different areas where you can contribute to: +Framework Tracker has a few different areas which you can contribute to: + +- **Improving Metrics**: Suggest new metrics or improve the way we collect and display existing ones. Find out current roadmap and metrics in [initial-comparison-list.md](./initial-comparison-list.md#ComparableMetrics). -- **Improving Metrics**: Suggest new metrics or improve the way we collect and display existing ones. - **Documentation**: Enhance our documentation site by fixing typos, improving explanations, or adding new sections. UI/UX improvements are also welcome! -- **Adding New Frameworks**: Help us expand our list of tracked frameworks by adding new ones and gathering relevant metrics. Check out [initial-comparison-list.md](./initial-comparison-list.md#frameworks) for the list of currently tracked frameworks and metrics. Be careful when adding a new framework as in its current state adding a new framework adds to the maintenance burden. + +- **Adding New Frameworks**: Help us expand our list of tracked frameworks by adding new ones. Check out [initial-comparison-list.md](./initial-comparison-list.md#frameworks) for the list of planned tracked frameworks. Be careful when adding a new framework as in its current state adding a new framework adds to the maintenance burden. ### How Metrics Work -We currently run scripts into the CI to measure and collect metrics for each framework. Right now we measure each frameworks starter project. In our current pipeline there will be an option to re-implement the same App in each framework to measure certain metrics. (this is why each stats content in the Astro site has a type value of either "starter" or "app".) +We currently run scripts in the CI to measure and collect metrics for each framework. Right now we measure each frameworks starter project. The current flow for collecting metrics is as follows: 1. A PR is merged which triggers the CI Pipeline: `generate-stats` 2. The CI Pipeline runs and measures different metrics for each framework 3. The collected metrics are passed into the final step which runs the scripts in `stats-generator` -4. The `stats-generator` does some measure of its own and then create a content.json file for each framework in the Astro docs site. +4. The `stats-generator` does some measure of its own and then creates a content.json file for each framework in the Astro docs site.