Skip to content

Commit 306d537

Browse files
authored
docs: add table of contents to contribution guidelines (#773)
Co-authored-by: Cassidy Williams <cassidoo@users.noreply.github.com>
1 parent a820106 commit 306d537

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,43 @@ We want to create 'a fast, modern browser for the npm registry.' This means, amo
1414
- Layout shift, flakiness, slowness is The Worst. We need to continually iterate to create the most performant, best DX possible.
1515
- We want to provide information in the best way. We don't want noise, cluttered display, or confusing UI. If in doubt: choose simplicity.
1616

17+
## Table of Contents
18+
19+
- [Getting started](#getting-started)
20+
- [Prerequisites](#prerequisites)
21+
- [Setup](#setup)
22+
- [Development workflow](#development-workflow)
23+
- [Available commands](#available-commands)
24+
- [Project structure](#project-structure)
25+
- [Local connector CLI](#local-connector-cli)
26+
- [Code style](#code-style)
27+
- [TypeScript](#typescript)
28+
- [Server API patterns](#server-api-patterns)
29+
- [Import order](#import-order)
30+
- [Naming conventions](#naming-conventions)
31+
- [Vue components](#vue-components)
32+
- [RTL Support](#rtl-support)
33+
- [Localization (i18n)](#localization-i18n)
34+
- [Approach](#approach)
35+
- [Adding a new locale](#adding-a-new-locale)
36+
- [Update translation](#update-translation)
37+
- [Adding translations](#adding-translations)
38+
- [Translation key conventions](#translation-key-conventions)
39+
- [Using i18n-ally (recommended)](#using-i18n-ally-recommended)
40+
- [Formatting numbers and dates](#formatting-numbers-and-dates)
41+
- [Testing](#testing)
42+
- [Unit tests](#unit-tests)
43+
- [Component accessibility tests](#component-accessibility-tests)
44+
- [End to end tests](#end-to-end-tests)
45+
- [Submitting changes](#submitting-changes)
46+
- [Before submitting](#before-submitting)
47+
- [Pull request process](#pull-request-process)
48+
- [Commit messages and PR titles](#commit-messages-and-pr-titles)
49+
- [Pre-commit hooks](#pre-commit-hooks)
50+
- [Using AI](#using-ai)
51+
- [Questions](#questions)
52+
- [License](#license)
53+
1754
## Getting started
1855

1956
### Prerequisites
@@ -111,7 +148,7 @@ To help with this, the project uses `oxfmt` to handle formatting via a pre-commi
111148

112149
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.
113150

114-
### Typescript
151+
### TypeScript
115152

116153
- We care about good types &ndash; never cast things to `any` 💪
117154
- Validate rather than just assert

0 commit comments

Comments
 (0)