Contributor Manual
Foreword
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.
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.
TIP
New to open source? Take a look at the Open Source or First Contributions guides for helpful information on contributing to open source projects.
First Steps
There are many ways to contribute to Hey API. Most of them don't involve writing any code!
Read the documentation. Start with the Get Started guide. If you find anything broken or confusing, you can suggest improvements by clicking "Edit" at the bottom of any page.
Browse open issues. Help others by providing workarounds, asking for clarification, triaging, or suggesting labels on open issues. If you see something you would like to work on, consider opening a pull request.
Participate in discussions. Ask or answer questions, provide feedback, or suggest new ideas. Every idea is welcome, no matter how big or small.
Engage on social media. Help others discover Hey API by engaging with our posts on LinkedIn, Bluesky, or X. Share your experiences with Hey API on Reddit, Slack, or in your own communities and group chats.
Create a new issue. If you can't find a solution, open an issue. The issue template will guide you through the process.
Open a pull request. If you find an issue you would like to fix, open a pull request. If you need help, tag
@mrlubos
on GitHub, provide enough relevant information, and we will do our best to assist you.
These are some of the best ways not only to contribute to Hey API, but also to learn, connect with others, and share ideas.
Pull Requests
Ready to write some code? We have dedicated guides to help you build, develop, and test your feature before it's released.
We are excited to see what you’ll contribute!