Created CONTRIBUTING.md with contribution guidelines#20
Open
AppleDinger wants to merge 1 commit intopronskiy:mainfrom
Open
Created CONTRIBUTING.md with contribution guidelines#20AppleDinger wants to merge 1 commit intopronskiy:mainfrom
AppleDinger wants to merge 1 commit intopronskiy:mainfrom
Conversation
Added contributing guidelines for the PHP Debugger project, including PR process, branching guidelines, development setup, code style, testing requirements, and licensing.
There was a problem hiding this comment.
Pull request overview
Adds a contributor guide for the PHP Debugger repository to standardize PR workflow, branching, build steps, and testing expectations.
Changes:
- Introduces PR process guidelines (reviews, one-change-per-PR, diff hygiene)
- Documents branch naming conventions and basic build steps
- Documents testing expectations and how to run the test suite
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+2
| CONTRIBUTING.md | ||
| Contributing to PHP Debugger |
Comment on lines
+5
to
+15
| 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: |
Comment on lines
+33
to
+36
| Bash | ||
| phpize | ||
| ./configure --enable-php-debugger | ||
| make |
Comment on lines
+49
to
+53
| 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/ |
| 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. |
Collaborator
There was a problem hiding this comment.
Would be good to add a link to the license here
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added contributing guidelines for the PHP Debugger project, including PR process, branching guidelines, development setup, code style, testing requirements, and licensing.
Fixes #16