Contributing

Hey there! 👋 Welcome to the Transcript-Seeker project! We're absolutely thrilled that you're interested in contributing. Whether you're fixing a bug, adding a feature, or sharing an idea, your efforts help make our project better and more useful for everyone. Here are some easy-to-follow guidelines to help you dive in!

Table of Contents

• Issues
• Pull Requests
• Local Setup
• Environment Variables
• Conventional Commits
• Code Formatting

Issues

Have you found a bug, got a suggestion, or stumbled upon something that doesn't work as expected? No problem! Feel free to open an issue. When submitting an issue, try to include a clear and concise title and as many details as possible. The more info you provide, the faster we can jump in and help!

Pull Requests

We love pull requests! 🎉 If you'd like to make a contribution, whether it’s a bug fix, a feature, or a small improvement, follow these steps:

1. Fork the repo to your GitHub account.
2. Create a new branch with a meaningful name:
   • For bug fixes: fix/issue-123-bug-description
   • For new features: feat/awesome-new-feature
3. Make your changes, and make sure you follow our Conventional Commits guidelines.
4. Push your branch to your forked repository.
5. Open a pull request from your branch to the main branch of this repo.
6. Before submitting, make sure your code is clean by running:

   pnpm typecheck

   This will help catch any issues early on. 🚀

Local Setup

Ready to jump into the code? Awesome! Please follow this guide to get started.

Environment Variables

To learn more about configuring the environment variables, follow this guide.

Conventional Commits

We use Conventional Commits to keep our commit history clean and organized. It makes it easier for everyone to understand what's been done at a glance. Commit messages should use the following format:

<type>(<scope>): <description>

For example:

• feat(homepage): redesign the layout
• fix(styles): correct position of server status

Some common commit types:

• feat: A new feature.
• fix: A bug fix.
• docs: Documentation changes.
• style: Code style changes (formatting, missing semicolons, etc.).

Code Formatting

To keep the codebase consistent and readable, we recommend running a few checks before opening a pull request:

1. Lint fixes:

   pnpm lint:fix

2. Run type checks to ensure there are no type issues:

   pnpm typecheck

Your code should be well-tested, clear, and follow our best practices. Remember, every contribution makes a difference, and we deeply appreciate your help in making Transcript-Seeker better! 🎉

Thanks a ton for contributing, and welcome aboard! If you need any help, don’t hesitate to ask. Let’s make something amazing together. 🚀