PHP Classes

File: CONTRIBUTING.md

Recommend this page to a friend!
  Packages of Hichem Taboukouyout   Namecrement PHP   CONTRIBUTING.md   Download  
File: CONTRIBUTING.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: Namecrement PHP
Generate names that follow an incremental pattern
Author: By
Last change:
Date: 13 days ago
Size: 2,457 bytes
 

Contents

Class file image Download

? Contributing to Namecrement-php

Thank you for your interest in contributing to this project! Open source contributions help improve projects, introduce new ideas, and build a better community.

? Before You Start

Before contributing, please:

? Code of Conduct

Please ensure your contributions follow these general guidelines:

  • Be respectful and professional at all times.
  • Treat everyone in the community with kindness.
  • Discuss constructively and respectfully.

Any harassment or inappropriate behavior is strictly prohibited.

?? Setting Up Your Environment

To start contributing to the project, follow these steps:

  1. Fork this repository on GitHub.
  2. Clone your forked repository:

    git clone https://github.com/YOUR_GITHUB_USERNAME/Namecrement-php
    cd Namecrement-php
    
  3. Install dependencies:
composer install

? Making Changes

To submit a feature or bug fix, please:

  1. Create a branch from the `main` branch. Name the branch according to your feature or bug fix:

    git checkout -b feature/CoolNewFeature
    

    or for bug fixes:

    git checkout -b fix/bug-description
  2. After making your necessary changes, run relevant checks and tests to ensure everything works correctly:

    ./vendor/bin/pest
    
  3. Stage and commit your changes clearly describing what has been changed:

    git add .
    git commit -m 'feat: Add CoolNewFeature to improve performance'
    
  4. Push your branch to your forked repo:

    git push origin feature/CoolNewFeature
    

? Submitting a Pull Request

When your changes are ready:

  1. Open GitHub and navigate to your forked repository.
  2. Click `Compare & pull request`.
  3. Clearly explain the following in your pull request description: - What changes you made and why they are needed. - Any linked relevant issues (e.g., "Closes #number").
  4. Wait for project maintainers review to suggest changes or to merge your PR.

? Commit Message Guidelines

Write clear commit messages, formatted this way: