fork of hey-api/openapi-ts because I need some additional things
Merge pull request #2358 from hey-api/docs/contributing-overview
docs: add contributor manual overview
+197
-87
+23
docs/.vitepress/config/en.ts
+23
docs/.vitepress/config/en.ts
···
5
5
'🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.',
6
6
lang: 'en-US',
7
7
themeConfig: {
8
+
editLink: {
9
+
pattern: 'https://github.com/hey-api/openapi-ts/edit/main/docs/:path',
10
+
text: 'Edit',
11
+
},
8
12
footer: {
9
13
message: 'Released under the MIT License.',
10
14
},
···
14
18
text: 'Sponsor Hey API',
15
19
},
16
20
],
21
+
outline: {
22
+
label: 'Table of Contents',
23
+
level: 2,
24
+
},
17
25
sidebar: [
18
26
{
19
27
items: [
···
236
244
text: 'Spotlight',
237
245
},
238
246
{
247
+
collapsed: true,
248
+
items: [
249
+
{
250
+
link: '/openapi-ts/community/contributing/building',
251
+
text: 'Building',
252
+
},
253
+
{
254
+
link: '/openapi-ts/community/contributing/developing',
255
+
text: 'Developing',
256
+
},
257
+
{
258
+
link: '/openapi-ts/community/contributing/testing',
259
+
text: 'Testing',
260
+
},
261
+
],
239
262
link: '/openapi-ts/community/contributing',
240
263
text: 'Contributing',
241
264
},
+23
docs/.vitepress/theme/components/FeatureStatus.vue
+23
docs/.vitepress/theme/components/FeatureStatus.vue
···
1
+
<script setup lang="ts">
2
+
const props = defineProps<{
3
+
issueNumber: number;
4
+
name: string;
5
+
}>();
6
+
</script>
7
+
8
+
<template>
9
+
<div class="warning custom-block">
10
+
<p class="custom-block-title">Excited about {{ props.name }}?</p>
11
+
<p>
12
+
Help us prioritize this feature by voting on
13
+
<a
14
+
:href="`https://github.com/hey-api/openapi-ts/issues/${props.issueNumber}`"
15
+
rel="noreferrer"
16
+
target="_blank"
17
+
>GitHub</a
18
+
>
19
+
or consider becoming a
20
+
<a href="/openapi-ts/community/spotlight">contributor</a>.
21
+
</p>
22
+
</div>
23
+
</template>
+11
-1
docs/.vitepress/theme/components/Heading.vue
+11
-1
docs/.vitepress/theme/components/Heading.vue
···
1
+
<script setup lang="ts">
2
+
const props = defineProps<{
3
+
spaceBetween?: boolean;
4
+
}>();
5
+
</script>
6
+
1
7
<template>
2
-
<div class="container">
8
+
<div class="container" :class="{ 'space-between': props.spaceBetween }">
3
9
<slot />
4
10
</div>
5
11
</template>
···
9
15
align-items: center;
10
16
column-gap: 1rem;
11
17
display: flex;
18
+
}
19
+
20
+
.space-between {
21
+
justify-content: space-between;
12
22
}
13
23
</style>
+2
docs/.vitepress/theme/index.ts
+2
docs/.vitepress/theme/index.ts
···
6
6
import './custom.css';
7
7
8
8
import AuthorsList from './components/AuthorsList.vue';
9
+
import FeatureStatus from './components/FeatureStatus.vue';
9
10
import Heading from './components/Heading.vue';
10
11
import VersionLabel from './components/VersionLabel.vue';
11
12
import VersionSwitcher from './components/VersionSwitcher.vue';
···
15
16
Layout,
16
17
enhanceApp: ({ app }) => {
17
18
app.component('AuthorsList', AuthorsList);
19
+
app.component('FeatureStatus', FeatureStatus);
18
20
app.component('Heading', Heading);
19
21
app.component('VersionLabel', VersionLabel);
20
22
app.component('VersionSwitcher', VersionSwitcher);
-4
docs/openapi-ts/clients/axios.md
-4
docs/openapi-ts/clients/axios.md
···
12
12
<VersionLabel value="v1" />
13
13
</Heading>
14
14
15
-
::: warning
16
-
Axios client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
17
-
:::
18
-
19
15
### About
20
16
21
17
[Axios](https://axios-http.com) is a simple promise based HTTP client for the browser and Node.js. Axios provides a simple to use library in a small package with a very extensible interface.
-4
docs/openapi-ts/clients/fetch.md
-4
docs/openapi-ts/clients/fetch.md
···
9
9
10
10
# Fetch API
11
11
12
-
::: warning
13
-
Fetch API client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
14
-
:::
15
-
16
12
### About
17
13
18
14
The [Fetch API](https://developer.mozilla.org/docs/Web/API/Fetch_API) provides an interface for fetching resources (including across the network). It is a more powerful and flexible replacement for XMLHttpRequest.
-4
docs/openapi-ts/clients/next-js.md
-4
docs/openapi-ts/clients/next-js.md
···
5
5
6
6
# Next.js
7
7
8
-
::: warning
9
-
Next.js client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
10
-
:::
11
-
12
8
### About
13
9
14
10
[Next.js](https://nextjs.org) is the React framework for the web. Used by some of the world's largest companies, Next.js enables you to create high-quality web applications with the power of React components.
+32
-11
docs/openapi-ts/community/contributing.md
+32
-11
docs/openapi-ts/community/contributing.md
···
1
1
---
2
2
title: Contributing
3
-
description: Learn how to contribute to @hey-api/openapi-ts.
3
+
description: Learn how to contribute to Hey API.
4
4
---
5
5
6
-
# Contributing
6
+
# Contributor Manual
7
+
8
+
## Foreword
9
+
10
+
Hey API is building an OpenAPI to TypeScript code generator ecosystem. It’s trusted by thousands of companies – from YC startups to Fortune 500 enterprises – and powers products used by millions worldwide.
11
+
12
+
We welcome contributors of all backgrounds and experience levels. Whether you’re fixing a typo or building a new feature, your input matters. If you need guidance, help with technical writing, or want to bring a feature idea to life, we’re here to support you.
13
+
14
+
::: tip
15
+
16
+
New to open source? Take a look at the [Open Source](https://opensource.guide/) or [First Contributions](https://github.com/firstcontributions/first-contributions) guides for helpful information on contributing to open source projects.
17
+
18
+
:::
19
+
20
+
## First Steps
21
+
22
+
There are many ways to contribute to Hey API. Most of them don't involve writing any code!
23
+
24
+
- **Read the documentation**. Start with the [Get Started](/openapi-ts/get-started) guide. If you find anything broken or confusing, you can suggest improvements by clicking "Edit" at the bottom of any page.
25
+
26
+
- **Browse open issues**. Help others by providing workarounds, asking for clarification, triaging, or suggesting labels on [open issues](https://github.com/hey-api/openapi-ts/issues). If you see something you would like to work on, consider opening a pull request.
27
+
28
+
- **Participate in discussions**. Ask or [answer questions](https://github.com/orgs/hey-api/discussions), provide feedback, or suggest new ideas. Every idea is welcome, no matter how big or small.
29
+
30
+
- **Engage on social media**. Help others discover Hey API by engaging with our posts on [LinkedIn](https://linkedin.com/company/heyapi), [Bluesky](https://bsky.app/profile/heyapi.dev), or [X](https://x.com/mrlubos). Share your experiences with Hey API on Reddit, Slack, or in your own communities and group chats.
7
31
8
-
Thank you for considering contributing to Hey API. In order to increase the likelihood of your changes being merged, first open an issue if one does not already exist. Once an issue exists, let us know you'd like to work on it. We will confirm whether we're looking to resolve the issue and provide you with guidance if required. This is to ensure our codebase remains in good state and all features contribute to Hey API's objectives.
32
+
- **Create a new issue**. If you can't find a solution, [open an issue](https://github.com/hey-api/openapi-ts/issues). The issue template will guide you through the process.
9
33
10
-
## Prerequisites
34
+
- **Open a pull request**. If you find an issue you would like to fix, open a pull request. If you need help, tag [`@mrlubos`](https://github.com/mrlubos) on GitHub, provide enough relevant information, and we will do our best to assist you.
11
35
12
-
You should have a working knowledge of [git](https://git-scm.com), [node](https://nodejs.org/en), and [pnpm](https://pnpm.io).
36
+
These are some of the best ways not only to contribute to Hey API, but also to learn, connect with others, and share ideas.
13
37
14
-
## Guidelines
38
+
## Pull Requests
15
39
16
-
Your [pull request](https://help.github.com/articles/using-pull-requests) must:
40
+
Ready to write some code? We have dedicated guides to help you [build](/openapi-ts/community/contributing/building), [develop](/openapi-ts/community/contributing/developing), and [test](/openapi-ts/community/contributing/testing) your feature before it's released.
17
41
18
-
- address a single issue or add a single item of functionality
19
-
- contain a clean history of small, incremental, logically separate commits, with no merge commits
20
-
- use clear commit messages
21
-
- be possible to merge automatically
42
+
We are excited to see what you’ll contribute!
+23
docs/openapi-ts/community/contributing/building.md
+23
docs/openapi-ts/community/contributing/building.md
···
1
+
---
2
+
title: Building
3
+
description: Learn how to contribute to Hey API.
4
+
---
5
+
6
+
# Building
7
+
8
+
::: warning
9
+
This page is under construction. We appreciate your patience.
10
+
:::
11
+
12
+
## Prerequisites
13
+
14
+
You should have a working knowledge of [git](https://git-scm.com), [node](https://nodejs.org/en), and [pnpm](https://pnpm.io).
15
+
16
+
## Guidelines
17
+
18
+
Your [pull request](https://help.github.com/articles/using-pull-requests) must:
19
+
20
+
- address a single issue or add a single item of functionality
21
+
- contain a clean history of small, incremental, logically separate commits, with no merge commits
22
+
- use clear commit messages
23
+
- be possible to merge automatically
+10
docs/openapi-ts/community/contributing/developing.md
+10
docs/openapi-ts/community/contributing/developing.md
+10
docs/openapi-ts/community/contributing/testing.md
+10
docs/openapi-ts/community/contributing/testing.md
+44
-7
docs/openapi-ts/community/spotlight.md
+44
-7
docs/openapi-ts/community/spotlight.md
···
1
1
---
2
2
title: Spotlight
3
-
description: Meet the people behind @hey-api/openapi-ts.
3
+
description: Meet the people behind Hey API.
4
4
---
5
5
6
6
<script setup lang="ts">
···
11
11
12
12
# Spotlight
13
13
14
-
Meet the people behind `@hey-api/openapi-ts`.
14
+
Meet the people behind Hey API. To join this list, please refer to the [contributing](/openapi-ts/community/contributing) guide.
15
15
16
16
## Core Team
17
17
18
-
These people actively maintain this project.
18
+
These people actively maintain Hey API.
19
19
20
-
<VPTeamMembers size="small" :members="coreTeam" />
20
+
<VPTeamMembers class="people" size="small" :members="coreTeam" />
21
21
22
22
Do you want to join the core team? Send us a short [email](mailto:lubos@heyapi.dev?subject=Join%20Core%20Team) describing your interest in Hey API, any relevant experience, and what you're hoping to work on.
23
23
···
25
25
26
26
These are the people with significant contributions to Hey API. A special thank you goes to [Ferdi Koomen](https://madebyferdi.com) for allowing us to use the original source code from OpenAPI TypeScript Codegen. None of this would've been possible without you!
27
27
28
-
<VPTeamMembers size="small" :members="hallOfFame" />
28
+
<VPTeamMembers class="people" size="small" :members="hallOfFame" />
29
29
30
30
## Contributors
31
31
32
-
A complete list of contributors to `@hey-api/openapi-ts`.
32
+
The complete list of contributors to Hey API.
33
33
34
34
<div class="contributors-list">
35
35
···
37
37
38
38
</div>
39
39
40
-
Thank you for contributing to Hey API!
40
+
A sincere thank you for your contributions.
41
+
42
+
<style>
43
+
.vp-doc .VPTeamMembers.people.small .container {
44
+
grid-template-columns: repeat(auto-fit, minmax(284px, 1fr)) !important;
45
+
}
46
+
47
+
@media (max-width: 640px) {
48
+
.vp-doc .VPTeamMembers.people.small .container {
49
+
max-width: 100% !important;
50
+
}
51
+
}
52
+
53
+
.VPTeamMembersItem.small {
54
+
max-width: 400px;
55
+
}
56
+
57
+
.VPTeamMembersItem.small .profile {
58
+
align-items: center;
59
+
display: flex;
60
+
padding: 1rem 1.4rem !important;
61
+
}
62
+
63
+
.VPTeamMembersItem.small .profile .avatar {
64
+
margin: 0 1rem 0 0;
65
+
}
66
+
67
+
.VPTeamMembersItem.small .profile .data {
68
+
padding: 0;
69
+
text-align: left;
70
+
}
71
+
72
+
.VPTeamMembersItem.small .profile .data .links {
73
+
justify-content: initial;
74
+
margin: 0 -8px -20px;
75
+
padding: 4px 0;
76
+
}
77
+
</style>
+1
-3
docs/openapi-ts/plugins/ajv.md
+1
-3
docs/openapi-ts/plugins/ajv.md
+1
-3
docs/openapi-ts/plugins/arktype.md
+1
-3
docs/openapi-ts/plugins/arktype.md
+1
-3
docs/openapi-ts/plugins/express.md
+1
-3
docs/openapi-ts/plugins/express.md
+1
-3
docs/openapi-ts/plugins/faker.md
+1
-3
docs/openapi-ts/plugins/faker.md
+1
-3
docs/openapi-ts/plugins/hono.md
+1
-3
docs/openapi-ts/plugins/hono.md
+1
-3
docs/openapi-ts/plugins/joi.md
+1
-3
docs/openapi-ts/plugins/joi.md
+1
-3
docs/openapi-ts/plugins/koa.md
+1
-3
docs/openapi-ts/plugins/koa.md
+1
-3
docs/openapi-ts/plugins/msw.md
+1
-3
docs/openapi-ts/plugins/msw.md
+1
-3
docs/openapi-ts/plugins/nest.md
+1
-3
docs/openapi-ts/plugins/nest.md
+1
-3
docs/openapi-ts/plugins/nock.md
+1
-3
docs/openapi-ts/plugins/nock.md
+1
-3
docs/openapi-ts/plugins/pinia-colada.md
+1
-3
docs/openapi-ts/plugins/pinia-colada.md
···
5
5
6
6
# Pinia Colada <span data-soon>soon</span>
7
7
8
-
::: warning
9
-
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1242).
10
-
:::
8
+
<FeatureStatus issueNumber=1242 name="Pinia Colada" />
11
9
12
10
### About
13
11
+1
-3
docs/openapi-ts/plugins/superstruct.md
+1
-3
docs/openapi-ts/plugins/superstruct.md
···
5
5
6
6
# Superstruct <span data-soon>soon</span>
7
7
8
-
::: warning
9
-
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1489).
10
-
:::
8
+
<FeatureStatus issueNumber=1489 name="Superstruct" />
11
9
12
10
### About
13
11
+1
-3
docs/openapi-ts/plugins/supertest.md
+1
-3
docs/openapi-ts/plugins/supertest.md
···
5
5
6
6
# Supertest <span data-soon>soon</span>
7
7
8
-
::: warning
9
-
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1488).
10
-
:::
8
+
<FeatureStatus issueNumber=1488 name="Supertest" />
11
9
12
10
### About
13
11
+1
-3
docs/openapi-ts/plugins/swr.md
+1
-3
docs/openapi-ts/plugins/swr.md
-4
docs/openapi-ts/plugins/tanstack-query.md
-4
docs/openapi-ts/plugins/tanstack-query.md
···
12
12
<VersionLabel value="v5" />
13
13
</Heading>
14
14
15
-
::: warning
16
-
TanStack Query plugin is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
17
-
:::
18
-
19
15
### About
20
16
21
17
[TanStack Query](https://tanstack.com/query) is a powerful asynchronous state management solution for TypeScript/JavaScript, React, Solid, Vue, Svelte, and Angular.
+1
-3
docs/openapi-ts/plugins/typebox.md
+1
-3
docs/openapi-ts/plugins/typebox.md
+1
-3
docs/openapi-ts/plugins/yup.md
+1
-3
docs/openapi-ts/plugins/yup.md
+1
-3
docs/openapi-ts/plugins/zustand.md
+1
-3
docs/openapi-ts/plugins/zustand.md