Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

76 lines (54 loc) · 3.64 KB

Contributing to PHP Debugging Tool

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to the PHP Debugging Tool, which is hosted in the 1manfactory/php-debugging-tool repository on GitHub.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for the PHP Debugging Tool. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating a bug report, please check the issues to see if the problem has already been reported. When you create a bug report, please include as many details as possible.

How to Submit a Bug Report

  1. Open a new issue and select the "Bug report" template.
  2. Describe the bug: Provide a clear and concise description of what the bug is.
  3. Steps to reproduce: Provide steps to reproduce the behavior. If possible, create a minimal reproducible example.
  4. Expected behavior: Describe what you expected to happen.
  5. Screenshots: If applicable, add screenshots to help explain your problem.
  6. Environment: Include any details about your environment, such as PHP version, operating system, and any relevant configurations.
  7. Additional context: Add any other context about the problem here.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for the PHP Debugging Tool, including completely new features and minor improvements to existing functionality.

How to Submit an Enhancement Suggestion

  1. Open a new issue and select the "Feature request" template.
  2. Describe the enhancement: Provide a clear and concise description of what you want to happen.
  3. Motivation: Explain why this feature would be useful to you and others.
  4. Additional context: Add any other context or screenshots about the feature request here.

Contributing Code

This section guides you through contributing code to the PHP Debugging Tool. Please follow these guidelines to help maintain a high standard of quality and consistency in the codebase.

Development Process

  1. Fork the repository to your own GitHub account.
  2. Clone the repository to your local machine: 
    git clone https://github.com/1manfactory/php-debugging-tool.git
cd php-debugging-tool
  3. Create a new branch for your work: 
    git checkout -b my-feature-branch
  4. Make your changes.
  5. Commit your changes with a clear and descriptive commit message: 
    git commit -m "Add feature XYZ"
  6. Push your changes to your fork: 
    git push origin my-feature-branch
  7. Open a Pull Request: Go to the original repository on GitHub and open a pull request with a clear title and description of your changes.

Coding Guidelines

  • Follow the PSR-12: Extended Coding Style Guide for PHP code.
  • Write clear, concise, and meaningful commit messages.
  • Add comments to explain the rationale behind your changes, especially if the code is complex or non-obvious.
  • Write tests to cover your changes when applicable.

Reviewing Pull Requests

Pull requests will be reviewed by project maintainers. Feedback will be provided, and changes may be requested. Be ready to iterate on your pull request to address any concerns or suggestions.

Thank You!

Thank you for considering contributing to the PHP Debugging Tool! Your contributions help make this project better for everyone.