From e2a690d4590474424085a97f5df7060f088502fd Mon Sep 17 00:00:00 2001 From: JonPurvis Date: Fri, 28 Feb 2025 02:19:15 +0000 Subject: [PATCH 1/2] update readme --- README.md | 19 +++++++++++++------ composer.json | 2 +- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9e04013..28bde74 100644 --- a/README.md +++ b/README.md @@ -80,11 +80,18 @@ Squeaky currently supports the following languages: - Dutch ## Contributing -Contributions to the package are more than welcome! +Contributions to the package are more than welcome! Depending on the type of change, there's a few extra steps that will +need carrying out: -For profanity additions, these will need adding into -[Profanify](https://github.com/JonPurvis/profanify) and then a new release will need to be tagged so this package can -use them. +### Existing Locale Changes +These changes should be done in [Profanify](https://github.com/JonPurvis/profanify) and a new release should be tagged. +Dependabot will then open a PR on this repo. Once that's been merged, it should be good to go because the config will +already be getting loaded. -If you want to support a new language, once it's been added to [Profanify](https://github.com/JonPurvis/profanify), -it will then need adding in the `boot` method of the `SqueakyServiceProvider` class in this package. +### New Locale Support +The new locale config will need adding to [Profanify](https://github.com/JonPurvis/profanify) first and a new release +should be tagged. Dependabot will then open a PR on this repo. Additionally, the new config will need loading in +within the `boot` method of the service provider of this package. + +### Functionality Changes +For changes to how this rule works, these should be done in this package. No change needed to Profanify. diff --git a/composer.json b/composer.json index dc29038..fba8d9d 100644 --- a/composer.json +++ b/composer.json @@ -11,7 +11,7 @@ "homepage": "https://github.com/jonpurvis/squeaky", "license": "MIT", "require": { - "php": "^8.2|^8.3|^8.4", + "php": "^8.2", "illuminate/contracts": "^10.0 | ^11.0 | ^12.0", "jonpurvis/profanify": "^3.13", "spatie/laravel-package-tools": "^1.16" From 783f48b53b4b703ae84e5ea83e31c2a2aace1777 Mon Sep 17 00:00:00 2001 From: JonPurvis Date: Fri, 28 Feb 2025 02:21:58 +0000 Subject: [PATCH 2/2] update readme --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index fba8d9d..52bf40d 100644 --- a/composer.json +++ b/composer.json @@ -12,7 +12,7 @@ "license": "MIT", "require": { "php": "^8.2", - "illuminate/contracts": "^10.0 | ^11.0 | ^12.0", + "illuminate/contracts": "^10.0|^11.0|^12.0", "jonpurvis/profanify": "^3.13", "spatie/laravel-package-tools": "^1.16" },