Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (46 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

59 lines (46 loc) · 1.59 KB

Contributing to Twenty CRM PHP Client

Thank you for your interest in contributing to this project! We welcome contributions from the community.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone git@github.com:your-username/twenty-crm-php-client.git
cd twenty-crm-php-client
  3. Install dependencies: 
    composer install

Making Changes

  1. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  2. Make your changes
  3. Commit your changes with a clear commit message: 
    git commit -m "Add feature: description of your changes"
  4. Push your branch: 
    git push origin feature/your-feature-name
  5. Create a Pull Request on GitHub

Code Style

  • Follow PSR-12 coding standards
  • Use meaningful variable and method names
  • Add type hints for all parameters and return types
  • Document public methods and classes with DocBlocks

Reporting Issues

If you find a bug or have a feature request, please create an issue on GitHub with:

  • A clear description of the problem or feature
  • Steps to reproduce (for bugs)
  • Expected behavior
  • Your environment details (PHP version, etc.)

Pull Request Process

  1. Ensure your code follows the project's coding standards
  2. Update the README.md if you're adding new features
  3. Make sure your changes don't break existing functionality
  4. Provide a clear description of your changes in the PR

Questions?

If you have questions about contributing, feel free to open an issue or contact the maintainers.