From 3c36f181060423f2c4207b8a9649da69accd1ce9 Mon Sep 17 00:00:00 2001 From: Ram Date: Tue, 17 Mar 2026 22:54:41 +0530 Subject: [PATCH 1/3] Create CONTRIBUTING.md with contribution guidelines Added contributing guidelines for the PHP Debugger project, including PR process, branching guidelines, development setup, code style, testing requirements, and licensing. --- CONTRIBUTING.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8805d31 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,58 @@ +CONTRIBUTING.md +Contributing to PHP Debugger +Thank you for your interest in contributing to PHP Debugger! This project is an experiment in rapid PHP tool development, and we welcome community involvement to keep PHP tooling at the top of the industry. + +PR Process +Pull Requests Only: All changes must be submitted via Pull Requests. Direct pushes to the main branch are strictly prohibited. + +Review: Every PR requires a review before merging to ensure stability and performance. + +Focused Changes: One feature or fix per PR. If you find multiple things to fix, please submit them as separate Pull Requests. + +Diff Quality: Review your own diff before submitting. Every change should be intentional. Do not include tooling artifacts (.idea/, .vscode/, etc.) or reformat untouched code. + +Branching Guidelines +Create a branch from main using the following prefixes and kebab-case: + +feature/ (e.g., feature/file-exchange) + +fix/ (e.g., fix/path-traversal) + +docs/ + +refactor/ + +chore/ + +test/ + +Development Setup +How to Build +To compile the extension from source, ensure you have the PHP development headers installed, then run the following commands: + +Bash +phpize +./configure --enable-php-debugger +make +Code Style +Indentation: This project inherits its code style from Xdebug and uses tabs for indentation. + +Consistency: Maintain local consistency with existing files. + +Testing Requirements +We place a high priority on performance and stability. + +New Features: Any PR introducing new functionality must include corresponding .phpt tests in the tests/ directory. + +No Regressions: Your changes must not introduce new XFAIL (expected failure) regressions. + +How to Run Tests +You can run the test suite using the provided run-xdebug-tests.php script: + +Bash +TEST_PHP_ARGS='-dzend_extension=modules/php_debugger.so' php run-xdebug-tests.php -q tests/debugger/ +Getting Started +Check our Issue Tracker for "good first issue" labels to start contributing. + +License +By contributing to this project, you agree that your contributions will be licensed under The Xdebug License. From 27fcc3081aeae80ea6df01bc664960255aef61f7 Mon Sep 17 00:00:00 2001 From: Ram Date: Thu, 19 Mar 2026 14:53:49 +0530 Subject: [PATCH 2/3] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8805d31..d8a511a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,4 @@ -CONTRIBUTING.md -Contributing to PHP Debugger +# Contributing to PHP Debugger Thank you for your interest in contributing to PHP Debugger! This project is an experiment in rapid PHP tool development, and we welcome community involvement to keep PHP tooling at the top of the industry. PR Process From be33738bd994117f7977fd6c6e31ab1d4b5ec9c6 Mon Sep 17 00:00:00 2001 From: Ram Date: Thu, 19 Mar 2026 15:41:41 +0530 Subject: [PATCH 3/3] Refactor CONTRIBUTING.md for improved clarity Updated formatting and structure of the CONTRIBUTING.md file for better readability and organization. --- CONTRIBUTING.md | 53 ++++++++++++++++++++++++++----------------------- 1 file changed, 28 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8a511a..007cbd8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,57 +1,60 @@ # Contributing to PHP Debugger + Thank you for your interest in contributing to PHP Debugger! This project is an experiment in rapid PHP tool development, and we welcome community involvement to keep PHP tooling at the top of the industry. -PR Process -Pull Requests Only: All changes must be submitted via Pull Requests. Direct pushes to the main branch are strictly prohibited. +## PR Process +* Pull Requests Only: All changes must be submitted via Pull Requests. Direct pushes to the main branch are strictly prohibited. -Review: Every PR requires a review before merging to ensure stability and performance. +* Review: Every PR requires a review before merging to ensure stability and performance. -Focused Changes: One feature or fix per PR. If you find multiple things to fix, please submit them as separate Pull Requests. +* Focused Changes: One feature or fix per PR. If you find multiple things to fix, please submit them as separate Pull Requests. -Diff Quality: Review your own diff before submitting. Every change should be intentional. Do not include tooling artifacts (.idea/, .vscode/, etc.) or reformat untouched code. +* Diff Quality: Review your own diff before submitting. Every change should be intentional. Do not include tooling artifacts (.idea/, .vscode/, etc.) or reformat untouched code. -Branching Guidelines +## Branching Guidelines Create a branch from main using the following prefixes and kebab-case: -feature/ (e.g., feature/file-exchange) +* feature/ (e.g., feature/file-exchange) -fix/ (e.g., fix/path-traversal) +* fix/ (e.g., fix/path-traversal) -docs/ +* docs/ -refactor/ +* refactor/ -chore/ +* chore/ -test/ +* test/ -Development Setup -How to Build +## Development Setup +### How to Build To compile the extension from source, ensure you have the PHP development headers installed, then run the following commands: -Bash +``` phpize ./configure --enable-php-debugger make -Code Style -Indentation: This project inherits its code style from Xdebug and uses tabs for indentation. +``` +### Code Style +* Indentation: This project inherits its code style from Xdebug and uses tabs for indentation. -Consistency: Maintain local consistency with existing files. +* Consistency: Maintain local consistency with existing files. -Testing Requirements +## Testing Requirements We place a high priority on performance and stability. New Features: Any PR introducing new functionality must include corresponding .phpt tests in the tests/ directory. No Regressions: Your changes must not introduce new XFAIL (expected failure) regressions. -How to Run Tests +### How to Run Tests You can run the test suite using the provided run-xdebug-tests.php script: -Bash +``` TEST_PHP_ARGS='-dzend_extension=modules/php_debugger.so' php run-xdebug-tests.php -q tests/debugger/ -Getting Started -Check our Issue Tracker for "good first issue" labels to start contributing. +``` +## Getting Started +Check our [Issue Tracker] (https://github.com/pronskiy/php-debugger/issues) for "good first issue" labels to start contributing. -License -By contributing to this project, you agree that your contributions will be licensed under The Xdebug License. +## License +By contributing to this project, you agree that your contributions will be licensed under The Xdebug License. You can find the full text of the license here: [LICENSE](https://github.com/pronskiy/php-debugger/blob/main/LICENSE)