Contributing

How to contribute

TNTSearch is an open-source project and contributions are welcome. Whether you're fixing a bug, adding a feature, improving documentation, or writing tests, this guide will help you get started.


Getting started

  1. Fork the repository on GitHub: teamtnt/tntsearch
  2. Clone your fork locally:
    git clone https://github.com/YOUR_USERNAME/tntsearch.git
    cd tntsearch
    
  3. Install dependencies:
    composer install
    
  4. Run tests to make sure everything works:
    vendor/bin/phpunit
    

Making changes

  1. Create a new branch from master:
    git checkout -b my-feature
    
  2. Make your changes and write tests
  3. Run the test suite to verify nothing is broken:
    vendor/bin/phpunit
    
  4. Commit your changes with a clear message
  5. Push to your fork and open a pull request

Coding standards

  • Follow existing code style and conventions in the project
  • Write tests for new features and bug fixes
  • Keep pull requests focused on a single change
  • Include clear commit messages explaining what and why

Reporting bugs

When reporting a bug, include:

  • PHP version and operating system
  • TNTSearch version
  • Minimal steps to reproduce the issue
  • Expected vs actual behavior
  • Error messages or stack traces

Open issues at: github.com/teamtnt/tntsearch/issues


Feature requests

Feature requests are welcome. Open an issue describing:

  • The problem you're trying to solve
  • Your proposed solution (if any)
  • Use cases and examples
Previous
Index management