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:
-
Fork this repository on GitHub.
-
Clone your forked repository:
git clone https://github.com/YOUR_GITHUB_USERNAME/Namecrement-php
cd Namecrement-php
-
Install dependencies:
composer install
? Making Changes
To submit a feature or bug fix, please:
-
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
-
After making your necessary changes, run relevant checks and tests to ensure everything works correctly:
./vendor/bin/pest
-
Stage and commit your changes clearly describing what has been changed:
git add .
git commit -m 'feat: Add CoolNewFeature to improve performance'
-
Push your branch to your forked repo:
git push origin feature/CoolNewFeature
? Submitting a Pull Request
When your changes are ready:
-
Open GitHub and navigate to your forked repository.
-
Click `Compare & pull request`.
-
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").
-
Wait for project maintainers review to suggest changes or to merge your PR.
? Commit Message Guidelines
Write clear commit messages, formatted this way: |