Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 1.59 KB

Contributing to TAAPI PHP Library

Thank you for considering contributing to the TAAPI PHP Library! This document outlines the process for contributing to this project.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/taapi-php.git
  3. Create a new branch: git checkout -b feature/your-feature-name
  4. Install dependencies: composer install

Development Guidelines

Code Style

  • Follow PSR-12 coding standards
  • Use strict types: declare(strict_types=1);
  • Add PHPDoc comments to all public methods and classes
  • Use type hints for all parameters and return types

Testing

  • Write tests for all new features
  • Ensure all tests pass before submitting a PR: composer test
  • Maintain or improve code coverage
  • Add both unit and integration tests where appropriate

Commit Messages

  • Use clear and descriptive commit messages
  • Start with a verb in present tense (e.g., "Add", "Fix", "Update")
  • Reference issue numbers when applicable

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Update the CHANGELOG.md with your changes
  3. Ensure all tests pass
  4. Update documentation if you're changing functionality
  5. Submit your pull request with a clear description of the changes

Code of Conduct

  • Be respectful and inclusive
  • Welcome newcomers and help them get started
  • Focus on constructive feedback
  • Maintain a positive and collaborative environment

Questions?

If you have questions, feel free to open an issue or contact the maintainer at sovletig@gmail.com.

Thank you for your contributions!