Skip to content

Commit a8315b7

Browse files
committed
fix: some review edits
1 parent 7791d1b commit a8315b7

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

docs/adr/performance-wg.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Proposed
1515
## Context
1616

1717
Express has traditionally taken a very lax approach to performance. Historically this has meant poor outcomes with
18-
regard to performance and lack of visibility around how changes impact performance. The goal of this proposed working
18+
and lack of visibility around how changes impact performance. The goal of this working
1919
group is to centralize discussion so the whole ecosystem of packages can benefit from targeted performance work. The
20-
scope of this WG would be all active packages in the `expressjs`, `pillarjs` and `jshttp` orgs with a special focus on
20+
scope of this WG would be all active packages in the `expressjs`, `pillarjs` and `jshttp` orgs with an initial focus on
2121
the ones which are direct dependencies of `express` itself.
2222

2323
**Why do we need a working group?**
@@ -26,16 +26,19 @@ The current state is we have many open PRs, in flight initiatives, and planned f
2626
can easily have duplicated work, conflicting approaches, or focus on the wrong outcomes. By giving this WG scope over
2727
this we can centralize the discussion and plans so that we unlock better and faster work in the individual packages.
2828

29+
Additionally, there will be continued long term work to monitor and maintain the tooling. The WG structure gives a clear
30+
place for users, contributors, and other interested parties to go so it is less difficult to find across the many org's
31+
and repositories the project owns.
32+
2933
## Decision
3034

3135
Similar to the Security WG, we will setup a new repo (expressjs/perf-wg) and corresponding plan of action. The WG will
32-
be delegated responsibility for driving concensus around the current scope and future scope to be determined by the
33-
group once setup. This group will have three primary goals:
36+
be delegated responsibility for driving concensus on initiatives within scope. This group will have three primary goals:
3437

3538
1. Organize the effort. We want to make sure we are not rebuilding the same things or having the same disucssions in
3639
many package repos at once.
37-
2. Provide and maintain tooling for all the packages/repos to produce reliable performance metrics and benchmarks. This
38-
should include but is not limited to: workflows, infra and guidelines on types of benchmarks.
40+
2. Provide and maintain tooling for all the packages/repos to produce reliable performance metrics and benchmarks.
41+
Examples include: workflows, infra and guidelines on types of benchmarks
3942
3. Proritize and execute performance improvements across the packages. These do not need to be done *by* the members of
4043
the WG, but it would be good if we could get reviews by the team we will setup to ensure folks with most experience
4144
can help address performance issues across the project.
@@ -47,10 +50,10 @@ We will need to take a few actions to get this started:
4750
3. Write charter/goals doc in the new repo
4851
4. Schedule a recurring (monthly) meeting
4952

50-
Lastly, this work is being funded by the STF program. It is a part of our larger work around security improvements for
51-
the project. Because of this, we will need to have a bit more clarity on the scope of work and reporting so we can
52-
fulfill the contract requirements of that program. There are two parts of that program which fall under this WG's
53-
purview:
53+
### Relation to STF
54+
55+
Lastly, this kicko-off work is being funded by the STF program. It is a part of our larger work around security
56+
improvements for the project. There are two parts of that program which fall under this WG's purview:
5457

5558
1. Milestone 6: Monitor performance across Express and direct dependencies
5659
- Owner: @wesleytodd
@@ -62,10 +65,11 @@ purview:
6265
- Estimated Budget: €46,200
6366

6467
This funding does not mean the work can only be done by the owners, it just means that we are responsible for organizing
65-
and executing on the deliverables. This is our first attempt at doing a program like this, so hopefully we can deliver
66-
on this well and show other organizations that investing in Open Source is worthwhile.
68+
and executing on the deliverables. This is our first attempt at doing a program like this, so feedback is welcome.
6769

6870
## References
6971

7072
- https://github.com/expressjs/express/pull/6129
7173
- https://github.com/expressjs/express/issues/5998
74+
- open-telemetry/opentelemetry-js-contrib#2437
75+
- openjs-foundation/infrastructure#5

0 commit comments

Comments
 (0)