Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (64 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

91 lines (64 loc) · 2.4 KB

🤝 Contributing to Pandino

We welcome contributions! Here's how to get started quickly.

🚀 Quick Setup

# Clone and setup
git clone https://github.com/BlackBeltTechnology/pandino.git
cd pandino
pnpm install

# Build all packages
pnpm build

# Run tests
pnpm test

📋 Development Workflow

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes following our coding standards
  4. Test your changes: pnpm test
  5. Commit with conventional commits: feat: add amazing feature
  6. Push and create a Pull Request

🎯 What We Accept

Type Examples
🐛 Bug fixes Fix service registration race conditions
✨ Features New built-in services, bundle lifecycle improvements
📚 Documentation README improvements, code examples
🔧 Tooling Build improvements, test utilities
⚡ Performance Bundle startup optimizations

📝 Coding Standards

  • Tests required - New features need unit tests
  • Conventional commits - Use feat:, fix:, docs:, etc.
  • Code linter - We use OXC (runs automatically)
  • Code formatting - We use Biome (runs automatically)

🧪 Testing

# Run all tests
pnpm test

# Run tests in watch mode
pnpm test:watch

# Run tests with coverage
pnpm test:coverage

# Test specific package
pnpm --filter @pandino/pandino test

📦 Project Structure

packages/
├── pandino/          # Core framework
├── react-hooks/      # React integration
└── example/          # Demo application

🐛 Bug Reports

Include:

  • Environment - Node.js version, OS, package versions
  • Steps to reproduce - Minimal code example
  • Expected vs actual behavior
  • Error messages - Full stack traces

💬 Questions?

📄 License

By contributing, you agree your contributions will be licensed under the Eclipse Public License - v 2.0.

Thanks for making Pandino better! 🎉