Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (51 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 1.12 KB

Contributing

Thanks for considering contributing to Laravel Translations!

Setup

  1. Fork the repo on GitHub, then clone your fork:
git clone git@github.com:MohmmedAshraf/laravel-translations.git && cd laravel-translations
  1. Install dependencies:
composer install
npm install
  1. Create a branch:
git checkout -b feature/your-feature-name

Development

If you're working on frontend changes, run Vite in dev mode:

npm run dev

Before Submitting

  1. Format your code:
composer format
  1. Run tests:
composer test
  1. If you changed frontend files, build assets:
npm run build

Testing Locally

You can test your local copy in a Laravel app by adding a path repository to the app's composer.json:

{
    "repositories": [
        {
            "type": "path",
            "url": "/path/to/your/laravel-translations"
        }
    ]
}

Then run composer update.

Pull Requests

  • Write clear, descriptive commit messages
  • Include context on what and why in the PR description
  • Keep PRs focused — one feature or fix per PR