├── README.md ├── docs └── images │ └── spatie.png ├── .github └── workflows │ ├── update-changelog.yml │ └── phpstan.yml ├── profile └── readme.md └── CONTRIBUTING.md /README.md: -------------------------------------------------------------------------------- 1 | # .github 2 | -------------------------------------------------------------------------------- /docs/images/spatie.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/spatie/.github/main/docs/images/spatie.png -------------------------------------------------------------------------------- /.github/workflows/update-changelog.yml: -------------------------------------------------------------------------------- 1 | name: "Update Changelog" 2 | 3 | on: 4 | release: 5 | types: [released] 6 | 7 | jobs: 8 | update: 9 | runs-on: ubuntu-latest 10 | 11 | steps: 12 | - name: Checkout code 13 | uses: actions/checkout@v4 14 | with: 15 | ref: main 16 | 17 | - name: Update Changelog 18 | uses: stefanzweifel/changelog-updater-action@v1 19 | with: 20 | latest-version: ${{ github.event.release.name }} 21 | release-notes: ${{ github.event.release.body }} 22 | 23 | - name: Commit updated CHANGELOG 24 | uses: stefanzweifel/git-auto-commit-action@v5 25 | with: 26 | branch: main 27 | commit_message: Update CHANGELOG 28 | file_pattern: CHANGELOG.md 29 | -------------------------------------------------------------------------------- /.github/workflows/phpstan.yml: -------------------------------------------------------------------------------- 1 | name: PHPStan 2 | 3 | on: 4 | workflow_call: 5 | inputs: 6 | php-version: 7 | required: false 8 | type: string 9 | default: '8.3' 10 | secrets: 11 | composerAuth: 12 | required: false 13 | jobs: 14 | phpstan: 15 | name: phpstan 16 | runs-on: ubuntu-latest 17 | timeout-minutes: 5 18 | steps: 19 | - uses: actions/checkout@v4 20 | 21 | - name: Setup PHP 22 | uses: shivammathur/setup-php@v2 23 | with: 24 | php-version: ${{ inputs.php-version }} 25 | coverage: none 26 | 27 | - name: Install composer dependencies 28 | uses: ramsey/composer-install@v3 29 | env: 30 | COMPOSER_AUTH: ${{ secrets.composerAuth }} 31 | 32 | - name: Run PHPStan 33 | run: ./vendor/bin/phpstan --error-format=github 34 | -------------------------------------------------------------------------------- /profile/readme.md: -------------------------------------------------------------------------------- 1 | ## About Spatie 2 | 3 | [Spatie](https://spatie.be) crafts web applications, courses & open source packages in the Laravel ecosystem. 4 | 5 | We have built a collection of best-in-class products: 6 | 7 | - [Ray](https://myray.app): a desktop app to debug applications faster 8 | - [Flare](https://flareapp.io): the best exception tracker for PHP and Laravel application 9 | - [Mailcoach](https://mailcoach.app): a self-hosted solution for sending mails reliably 10 | - [Media Library Pro](https://medialibrary.pro): front-end components to upload and manage media 11 | - [Laravel Backup Server](https://spatie.be/products/laravel-backup-server): a package to easily back up multiple servers 12 | 13 | Our experience building PHP and Laravel applications is shared in these premium courses: 14 | 15 | - [Laravel Beyond CRUD](https://laravel-beyond-crud.com) 16 | - [Testing Laravel](https://testing-laravel.com) 17 | - [Laravel Package Training](https://laravelpackage.training) 18 | - [Writing Readable PHP](https://writing-readable-php.com) 19 | - [Laravel Event Sourcing](https://event-sourcing-laravel.com) 20 | - [Front Line PHP](https://front-line-php.com) 21 | 22 | We like to use Laravel for most of our projects and love to contribute to the awesome Laravel ecosystem. That's also why we have been building Laravel and PHP packages since 2015. Our packages have been downloaded more than a billion times! You'll find [a full list of free packages](https://spatie.be/open-source/packages) in the open source section of our website. 23 | 24 | Here are some of our open source highlights: 25 | 26 | - [laravel-backup](https://spatie.be/docs/laravel-backup/) 27 | - [laravel-medialibrary](https://spatie.be/docs/laravel-medialibrary/) 28 | - [laravel-query-builder](https://spatie.be/docs/laravel-query-builder) 29 | - [laravel-permission](https://spatie.be/docs/laravel-permission) 30 | - [browsershot](https://github.com/spatie/browsershot) 31 | - [phpunit-snapshot-assertions](https://github.com/spatie/phpunit-snapshot-assertions) 32 | 33 | You can help with our open source efforts in many ways: by [resolving open issues](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Aspatie+is%3Apublic+label%3A%22good+first+issue%22) or just by [sending us a postcard](https://spatie.be/open-source/postcards). 34 | 35 | You can support our open source work by sponsoring us [on GitHub](https://github.com/sponsors/spatie) or [by buying some of our cool merch](https://spatie.myspreadshop.net/). 36 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Contributions are **welcome** and will be fully **credited**. 4 | 5 | Please read and understand the contribution guide before creating an issue or pull request. 6 | 7 | ## Etiquette 8 | 9 | This project is open source, and as such, the maintainers give their free time to build and maintain the source code 10 | held within. They make the code freely available in the hope that it will be of use to other developers. It would be 11 | extremely unfair for them to suffer abuse or anger for their hard work. 12 | 13 | Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the 14 | world that developers are civilized and selfless people. 15 | 16 | It's the duty of the maintainer to ensure that all submissions to the project are of sufficient 17 | quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. 18 | 19 | ## Viability 20 | 21 | When requesting or submitting new features, first consider whether it might be useful to others. Open 22 | source projects are used by many developers, who may have entirely different needs to your own. Think about 23 | whether or not your feature is likely to be used by other users of the project. 24 | 25 | ## Procedure 26 | 27 | Before filing an issue: 28 | 29 | - Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. 30 | - Check to make sure your feature suggestion isn't already present within the project. 31 | - Check the pull requests tab to ensure that the bug doesn't have a fix in progress. 32 | - Check the pull requests tab to ensure that the feature isn't already in progress. 33 | 34 | Before submitting a pull request: 35 | 36 | - Check the codebase to ensure that your feature doesn't already exist. 37 | - Check the pull requests to ensure that another person hasn't already submitted the feature or fix. 38 | 39 | ## Requirements 40 | 41 | If the project maintainer has any additional requirements, you will find them listed here. 42 | 43 | - **[PSR-12 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer). 44 | 45 | - **Add tests!** - Your patch won't be accepted if it doesn't have tests. 46 | 47 | - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. 48 | 49 | - **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option. 50 | 51 | - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. 52 | 53 | - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. 54 | 55 | **Happy coding**! 56 | --------------------------------------------------------------------------------