Skip to content

Commit 1532b07

Browse files
committed
Update contributing
1 parent cbec1ab commit 1532b07

1 file changed

Lines changed: 13 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,16 @@ Thank you for your interest in contributing! ❤️ This document provides guide
88
99
## Goals
1010

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 browser for the npm registry.
1212

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+
We're not replacing the [npmjs.com](https://www.npmjs.com/) registry, but instead providing an elevated developer experience through a fast, modern UI.
14+
15+
What npmx offers:
16+
17+
- **Speed** – Fast searching, filtering, and navigation.
18+
- **Simplicity** – Get the information you need when you need it in an intuitive UI.
19+
- **Compatibility** – Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works.
20+
- **Enhanced admin experience** – Manage your packages, teams, and organizations from the browser, powered by your local npm CLI.
1621

1722
## Table of Contents
1823

@@ -148,6 +153,10 @@ To help with this, the project uses `oxfmt` to handle formatting via a pre-commi
148153

149154
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.
150155

156+
### npmx name
157+
158+
If adding the name of the project to anywhere in the UI, use `npmx` in all lowercase letters.
159+
151160
### TypeScript
152161

153162
- We care about good types – never cast things to `any` 💪

0 commit comments

Comments
 (0)