|
| 1 | +# 🤝 Contributing to LaravelLangSyncInertia |
| 2 | + |
| 3 | +Thank you for considering contributing to **LaravelLangSyncInertia**! |
| 4 | +We welcome all kinds of contributions — from bug reports and feature requests to documentation improvements and pull requests. |
| 5 | + |
| 6 | +--- |
| 7 | + |
| 8 | +## 📋 Table of Contents |
| 9 | + |
| 10 | +- [Getting Started](#-getting-started) |
| 11 | +- [How to Contribute](#-how-to-contribute) |
| 12 | +- [Code Style](#-code-style) |
| 13 | +- [Pull Request Guidelines](#-pull-request-guidelines) |
| 14 | +- [Reporting Issues](#-reporting-issues) |
| 15 | +- [Feature Requests](#-feature-requests) |
| 16 | +- [Need Help?](#-need-help) |
| 17 | + |
| 18 | +--- |
| 19 | + |
| 20 | +## 🔧 Getting Started |
| 21 | + |
| 22 | +1. Fork the repository on GitHub. |
| 23 | +2. Clone your fork: |
| 24 | + |
| 25 | +```bash |
| 26 | +git clone https://github.com/your-username/laravel-lang-sync-inertia.git |
| 27 | +cd laravel-lang-sync-inertia |
| 28 | +```` |
| 29 | + |
| 30 | +3. Install dependencies: |
| 31 | + |
| 32 | +```bash |
| 33 | +composer install |
| 34 | +``` |
| 35 | + |
| 36 | +4. (Optional) For frontend contributions: |
| 37 | + |
| 38 | +```bash |
| 39 | +npm install |
| 40 | +npm run dev |
| 41 | +``` |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## 🧠 How to Contribute |
| 46 | + |
| 47 | +You can contribute in the following ways: |
| 48 | + |
| 49 | +* 📑 Improve documentation |
| 50 | +* 🐛 Report bugs |
| 51 | +* ✨ Suggest or implement features |
| 52 | +* 🧪 Write unit tests |
| 53 | +* 🔍 Review pull requests |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +## 🧹 Code Style |
| 58 | + |
| 59 | +This package follows: |
| 60 | + |
| 61 | +* [PSR-12](https://www.php-fig.org/psr/psr-12/) coding standards (use Laravel Pint or PHP-CS-Fixer) |
| 62 | +* Type-safe and readable PHP |
| 63 | +* Semantic and clean commit messages |
| 64 | + |
| 65 | +To format your code automatically: |
| 66 | + |
| 67 | +```bash |
| 68 | +./vendor/bin/pint |
| 69 | +``` |
| 70 | + |
| 71 | +--- |
| 72 | + |
| 73 | +## ✅ Pull Request Guidelines |
| 74 | + |
| 75 | +* ✅ Create a new branch from `main` |
| 76 | +* ✅ Keep your pull requests focused on one change |
| 77 | +* ✅ Write descriptive commit messages |
| 78 | +* ✅ Add tests for new features or fixes |
| 79 | +* ✅ Ensure all tests pass before submitting |
| 80 | + |
| 81 | +--- |
| 82 | + |
| 83 | +## 🐞 Reporting Issues |
| 84 | + |
| 85 | +When reporting a bug, please include: |
| 86 | + |
| 87 | +* Laravel version |
| 88 | +* Package version |
| 89 | +* Steps to reproduce |
| 90 | +* Expected vs actual behavior |
| 91 | +* Relevant error logs (if any) |
| 92 | + |
| 93 | +--- |
| 94 | + |
| 95 | +## 💡 Feature Requests |
| 96 | + |
| 97 | +We welcome ideas! If you have a feature request: |
| 98 | + |
| 99 | +* Please check for similar open issues first |
| 100 | +* Clearly explain the use case and benefit |
| 101 | +* If possible, suggest an API or usage example |
| 102 | + |
| 103 | +--- |
| 104 | + |
| 105 | +## 🆘 Need Help? |
| 106 | + |
| 107 | +If you’re stuck, open an [issue](https://github.com/eramitgupta/laravel-lang-sync-inertia/issues) or start a [discussion](https://github.com/eramitgupta/laravel-lang-sync-inertia/discussions). We'll be happy to help. |
| 108 | +
|
| 109 | +--- |
| 110 | +
|
| 111 | +Thank you again for contributing! 💙 |
| 112 | +
|
| 113 | +``` |
0 commit comments