Created CONTRIBUTING.md with contribution guidelines#20
Open
AppleDinger wants to merge 3 commits intophp-debugger:mainfrom
Open
Created CONTRIBUTING.md with contribution guidelines#20AppleDinger wants to merge 3 commits intophp-debugger:mainfrom
AppleDinger wants to merge 3 commits intophp-debugger: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.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Updated formatting and structure of the CONTRIBUTING.md file for better readability and organization.
There was a problem hiding this comment.
Pull request overview
Adds a new CONTRIBUTING.md at the repo root to document how to contribute to the PHP Debugger project, aligning with Issue #16’s request for build/test instructions and contribution expectations.
Changes:
- Introduces contribution workflow guidance (PR process and branch naming).
- Documents local development steps (build and test commands).
- Captures project conventions (tabs indentation) and contribution requirements (tests, no new XFAIL regressions).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pronskiy
requested changes
Mar 23, 2026
Comment on lines
+14
to
+28
| ## 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/ | ||
|
|
Collaborator
There was a problem hiding this comment.
Suggested change
| ## 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/ |
I don't think we care about branch names, do we?
| TEST_PHP_ARGS='-dzend_extension=modules/php_debugger.so' php run-xdebug-tests.php -q tests/debugger/ | ||
| ``` | ||
| ## Getting Started | ||
| Check our [Issue Tracker] (https://github.com/pronskiy/php-debugger/issues) for "good first issue" labels to start contributing. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Check our [Issue Tracker] (https://github.com/pronskiy/php-debugger/issues) for "good first issue" labels to start contributing. | |
| Check our [Issue Tracker](https://github.com/php-debugger/php-debugger/issues) for "good first issue" labels to start contributing. |
| 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. You can find the full text of the license here: [LICENSE](https://github.com/pronskiy/php-debugger/blob/main/LICENSE) |
Collaborator
There was a problem hiding this comment.
Suggested change
| 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) | |
| By contributing to this project, you agree that your contributions will be licensed under the project [LICENSE](LICENSE). |
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