You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+82-4Lines changed: 82 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,21 @@ Thank you for your interest in contributing! ❤️ This document provides guide
8
8
9
9
## Goals
10
10
11
-
We want to create 'a fast, modern browser for the npm registry.' This means, among other things:
11
+
The goal of [npmx.dev](https://npmx.dev) is to build a fast, modern and open-source browser for the npm registry, prioritizing speed, simplicity and a community-driven developer experience.
12
12
13
-
- We don't aim to replace the [npmjs.com](https://www.npmjs.com/) registry, just provide a better UI and DX.
14
-
- Layout shift, flakiness, slowness is The Worst. We need to continually iterate to create the most performant, best DX possible.
15
-
- We want to provide information in the best way. We don't want noise, cluttered display, or confusing UI. If in doubt: choose simplicity.
13
+
### Core values
14
+
15
+
- Speed
16
+
- Simplicity
17
+
- Community-first
18
+
19
+
### Target audience
20
+
21
+
npmx is built for open-source developers, by open-source developers.
22
+
23
+
Our goal is to create tools and capabilities that solve real problems for package maintainers and power users, while also providing a great developer experience for everyone who works in the JavaScript ecosystem.
24
+
25
+
This focus helps guide our project decisions as a community and what we choose to build.
16
26
17
27
## Table of Contents
18
28
@@ -42,6 +52,7 @@ We want to create 'a fast, modern browser for the npm registry.' This means, amo
@@ -148,6 +159,10 @@ To help with this, the project uses `oxfmt` to handle formatting via a pre-commi
148
159
149
160
If you want to get ahead of any formatting issues, you can also run `pnpm lint:fix` before committing to fix formatting across the whole project.
150
161
162
+
### npmx name
163
+
164
+
When displaying the project name anywhere in the UI, use `npmx` in all lowercase letters.
165
+
151
166
### TypeScript
152
167
153
168
- We care about good types – never cast things to `any` 💪
@@ -482,6 +497,69 @@ pnpm test:browser:ui # Run with Playwright UI
482
497
483
498
Make sure to read about [Playwright best practices](https://playwright.dev/docs/best-practices) and don't rely on classes/IDs but try to follow user-replicable behaviour (like selecting an element based on text content instead).
484
499
500
+
### Test fixtures (mocking external APIs)
501
+
502
+
E2E tests use a fixture system to mock external API requests, ensuring tests are deterministic and don't hit real APIs. This is handled at two levels:
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,13 +15,13 @@
15
15
16
16
The goal of [npmx.dev](https://npmx.dev) is to build a fast, modern browser for the npm registry.
17
17
18
-
We're not replacing the [npmjs.com](https://www.npmjs.com/) registry, but instead providing an elevated developer experience through a fast, modern UI.
18
+
We're not replacing the [npm](https://www.npmjs.com/) registry, but instead providing an elevated developer experience through a fast, modern UI.
19
19
20
20
What npmx offers:
21
21
22
22
-**Speed**– Fast searching, filtering, and navigation.
23
23
-**Simplicity**– Get the information you need when you need it in an intuitive UI.
24
-
-**Compatibility**– Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works.
24
+
-**URL Compatibility**– Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works.
25
25
-**Enhanced admin experience**– Manage your packages, teams, and organizations from the browser, powered by your local npm CLI.
0 commit comments