Contributing to APCu

Contributions to APCu are welcome! Whether you're fixing a bug, improving documentation, or proposing a new feature, your help is appreciated.

Reporting Bugs

If you find a bug, please open an issue on the GitHub repository. Please follow the guidelines from the README.md:

1. Minimal: Reduce your problem to the smallest amount of code possible.
2. Executable: Provide a complete script and all necessary information to run it.
3. Reproducing: Ensure the code reliably reproduces the bug. If it's intermittent, describe the conditions and how often it occurs.

Bug reports that do not include reproducing code may be closed.

Development Workflow

1. Fork and Clone: Fork the repository and clone it to your local machine.

2. Set up Build Environment: You will need a PHP development environment set up.

   git clone https://github.com/your-username/apcu.git
   cd apcu
   phpize
   ./configure --enable-apcu-debug

3. Make Changes: Implement your bug fix or feature.

4. Compile: Compile your changes.

   make

5. Run Tests: Before submitting, run the test suite to ensure your changes haven't introduced any regressions.

   make test

   The project's CI runs tests with different serializers. It's a good idea to do the same locally:

   make test TESTS="--show-diff -d apc.serializer=default tests"
   make test TESTS="--show-diff -d apc.serializer=php tests"

6. Submit a Pull Request: Push your changes to your fork and open a pull request against the master branch of the main APCu repository.