📦
Bunty

Contributing

Help us build the future of web development with Bun

🎉 Welcome Contributors!

We're excited to have you contribute to Bunty Framework! Whether you're fixing bugs, adding features, improving documentation, or sharing ideas, every contribution matters.

Ways to Contribute

🐛 Bug Reports

Found a bug? Help us fix it!

  • • Search existing issues first
  • • Provide clear reproduction steps
  • • Include environment details
  • • Add relevant code examples

💡 Feature Requests

Have an idea? We'd love to hear it!

  • • Explain the use case clearly
  • • Provide examples if possible
  • • Consider implementation challenges
  • • Discuss with the community first

📝 Documentation

Help others learn Bunty!

  • • Fix typos and grammar
  • • Add missing examples
  • • Improve existing guides
  • • Create new tutorials

⚡ Code Contributions

Ready to dive into the code?

  • • Check good first issues
  • • Follow coding standards
  • • Write comprehensive tests
  • • Update documentation

Getting Started

1. Fork & Clone

# Fork the repository on GitHub, then:
git clone https://github.com/YOUR-USERNAME/bunty-framework.git
cd bunty-framework

2. Setup Development Environment

# Install Bun (if not already installed)
curl -fsSL https://bun.sh/install | bash
# Install dependencies
bun install
# Run tests to ensure everything works
bun test

3. Create a Branch

git checkout -b feature/your-feature-name
# or for bug fixes:
git checkout -b fix/bug-description

Development Guidelines

Code Style

  • • Use TypeScript for all new code
  • • Follow existing naming conventions
  • • Use Prettier for code formatting (run bun format)
  • • Ensure ESLint passes (run bun lint)

Testing

  • • Write tests for new features
  • • Ensure all tests pass before submitting
  • • Aim for good test coverage
  • • Include both unit and integration tests

Commit Messages

Use conventional commit format:

feat: add query builder support for JSON columns
fix: resolve connection pooling memory leak
docs: update ORM setup guide with MySQL examples
refactor: simplify HTTP context handling

Pull Request Process

  1. 1
    Ensure your code is ready

    Tests pass, code is formatted, and documentation is updated

  2. 2
    Push your branch and create a PR

    Use a descriptive title and fill out the PR template

  3. 3
    Wait for review

    Maintainers will review and provide feedback

  4. 4
    Address feedback

    Make requested changes and push updates

  5. ✓
    Merge!

    Once approved, your contribution will be merged

Join Our Community

🗨️ Discussion

Join our GitHub Discussions to ask questions, share ideas, and connect with other contributors.

Join Discussions →

🐛 Issues

Check out our issues to find bugs to fix or features to implement.

View Issues →

Thank You! 🙏

Your contributions help make Bunty Framework better for everyone. We appreciate your time and effort!