-
-
Notifications
You must be signed in to change notification settings - Fork 7
Created CONTRIBUTING.md with contribution guidelines #20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
AppleDinger
wants to merge
3
commits into
pronskiy:main
Choose a base branch
from
AppleDinger:docs/contributing.md
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+60
−0
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +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. | ||
|
|
||
| * 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: | ||
|
|
||
| ``` | ||
| 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: | ||
|
|
||
| ``` | ||
| 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. | ||
|
|
||
| ## 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) | ||
AppleDinger marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.