|
| 1 | +# Contributing to Laravel PWA |
| 2 | + |
| 3 | +Thanks for your interest in contributing! 🧑💻 |
| 4 | + |
| 5 | +Please refer to the [README.md](./README.md) for complete setup instructions, usage guide, contribution workflow, and examples. |
| 6 | + |
| 7 | +## Quick Steps |
| 8 | + |
| 9 | + |
| 10 | +We appreciate your interest in contributing to this Laravel PWA project! Whether you're reporting issues, fixing bugs, or adding new features, your help is greatly appreciated. |
| 11 | + |
| 12 | +### Forking and Cloning the Repository |
| 13 | + |
| 14 | +1. Go to the repository page on GitHub. |
| 15 | +2. Click the **Fork** button at the top-right corner of the repository page. |
| 16 | +3. Clone your forked repository: |
| 17 | + |
| 18 | + |
| 19 | +bash |
| 20 | + git clone https://github.com/your-username/laravel-pwa.git |
| 21 | + |
| 22 | + |
| 23 | +### Reporting Issues |
| 24 | + |
| 25 | +If you encounter any issues, please check if the issue already exists in the **Issues** section. If not, create a new issue with the following details: |
| 26 | +- Steps to reproduce the issue |
| 27 | +- Expected and actual behavior |
| 28 | +- Laravel version |
| 29 | +- Any relevant logs or screenshots |
| 30 | + |
| 31 | +### Submit a Pull Request |
| 32 | + |
| 33 | +When you're ready to contribute, open a pull request describing the changes you’ve made and how they improve the project. Please ensure: |
| 34 | +- All commits are squashed into one clean commit. |
| 35 | +- The code follows **PSR-12** standards. |
| 36 | +- You’ve tested the changes locally. |
| 37 | + |
| 38 | +### Coding Standards |
| 39 | + |
| 40 | +- Follow the [PSR-12](https://www.php-fig.org/psr/psr-12/) PHP coding standards. |
| 41 | +- Keep your commit history clean and meaningful. |
| 42 | +- Add comments where needed but avoid over-commenting. |
| 43 | + |
| 44 | +## Example Workflow 🌟 |
| 45 | + |
| 46 | +Here’s a simple example of how to use this package: |
| 47 | + |
| 48 | +1. Install the package via Composer. |
| 49 | +2. Publish the configuration files. |
| 50 | +3. Add the @PwaHead directive in your layout file’s <head>. |
| 51 | +4. Add the @RegisterServiceWorkerScript directive before the closing </body> tag. |
| 52 | +5. Customize the config/pwa.php to fit your project’s needs. |
| 53 | +6. Run php artisan erag:pwa-update-manifest to update the manifest file. |
| 54 | + |
| 55 | + |
| 56 | +Let’s build something amazing together! 🚀 |
0 commit comments