First off, thank you for considering contributing to TubeCatalog! Your input helps improve the tool for creators and developers alike.
- Fork the repo
- Clone your fork
git clone https://github.com/lucab85/TubeCatalog.git cd TubeCatalog
3. **Install dependencies**
```bash
npm install
```
4. **Create a `.env` file**
```env
YOUTUBE_API_KEY=your_youtube_api_key
OPENAI_API_KEY=your_openai_api_key
```
5. **Start the dev server**
```bash
npm run dev
```
---
## 🚀 Contribution Types
We welcome:
* 🔧 Bug fixes
* ✨ New features
* 🧪 Test coverage improvements
* 🧹 Code cleanup / refactoring
* 📖 Documentation updates
* 🌐 Localization / i18n support
---
## 🛠️ Code Style & Guidelines
* Follow the existing **TypeScript**, **Radix UI**, and **Tailwind CSS** conventions.
* Use **clear commit messages**:
Examples:
* `fix: resolve YouTube API error when URL is malformed`
* `feat: add batch processing for multiple video URLs`
* `docs: update README with new deployment instructions`
---
## ✅ Pull Request Checklist
Before submitting:
* [ ] Lint your code (`npm run lint`)
* [ ] Ensure all new and existing tests pass
* [ ] Confirm app runs without errors
* [ ] Clearly describe what your PR does
* [ ] Reference any related issues (e.g., `Closes #5`)
---
## 💬 Communication
For major features or changes, please open a GitHub issue first to discuss your idea.
You can also connect via:
* [YouTube comments](https://youtube.com/@bertonluca)
* [LinkedIn](https://www.linkedin.com/in/lucaberton)
* [lucaberton.com](https://lucaberton.com)
Thanks for contributing to **TubeCatalog**! 🚀