Pre-Release Cleanup for v1.0.0

Author: andysnell

.dockerignore

@@ -1,7 +1,56 @@
-.github
-build
+# Ignore IDE, AI, & GitHub Directories
+/.cursor
+/.idea
+/.junie
+/.phpstorm.meta.php
+/.run
+/.vscode
+
+# Ignore GitHub Actions and CI/CD Directories
+/.github
+
+# Ignore Local, Build, Test and Vendor Directories
+/.local
+/build
+/deploy
+/database/dump/
+/infrastructure
+/public/local
+/public/phpunit
+/tests
+/vendor
+*.terraform
+
+# Ignore /storage, except for ".gitignore" files to preserve directory structure
 storage
-vendor
+!storage/**/.gitignore
+
+# Ignore environment files, except for the default distribution file
+.env
+.env.*
+*.private.env.json
+!.env.dist
+
+# Ignore boilerplate and development tooling files
+*.http
+.editorconfig
+.gitattributes
+.gitignore
+.prettierignore
+Dockerfile
+Makefile
+README.md
+behat.yml
 docker-compose.override.yml
-phpunit.xml
+docker-compose.yml
+http-client.env.json
+phpcs.xml
+phpstan-baseline.*.neon
+phpstan-baseline.*.php
+phpstan-baseline.neon
+phpstan-baseline.php
+phpstan.dist.neon
 phpstan.neon
+phpunit.dist.xml
+phpunit.xml
+rector.php

.editorconfig

@@ -12,5 +12,12 @@ charset = utf-8
 indent_style = space
 indent_size = 4
 
-[*.{yml,yaml}]
+[Makefile]
+indent_style = tab
+
+[*.http]
+end_of_line = crlf
+
+[*.{yml,yaml,json}]
 indent_size = 2
+max_line_length = unset

.env.dist

@@ -0,0 +1,12 @@
+##------------------------------------------------------------------------------
+# Container/Runtime Configuration
+##------------------------------------------------------------------------------
+
+# GitHub Token to Increase API Rate Limit and Enable Composer Authentication
+GITHUB_TOKEN=
+
+# XDebug Mode (https://xdebug.org/docs/all_settings#mode)
+XDEBUG_MODE=debug
+
+# XDebug Configuration (https://xdebug.org/docs/all_settings#XDEBUG_CONFIG)
+XDEBUG_CONFIG="client_host=host.docker.internal start_with_request=trigger idekey=PHPSTORM output_dir=/var/www/build/xdebug"

.gitattributes

@@ -1,11 +1,17 @@
+/.aiignore                  export-ignore
 /.allowed-licenses          export-ignore
+/.cursor                    export-ignore
+/.dockerignore              export-ignore
 /.editorconfig              export-ignore
 /.env                       export-ignore
-/.env.example               export-ignore
+/.env.dist                  export-ignore
 /.gitattributes             export-ignore
-/.github/                   export-ignore
+/.github                    export-ignore
 /.gitignore                 export-ignore
 /.idea                      export-ignore
+/.junie                     export-ignore
+/.prettierignore            export-ignore
+/.psysh.php                 export-ignore
 /CHANGELOG.md               export-ignore
 /CODE_OF_CONDUCT.md         export-ignore
 /CONTRIBUTING.md            export-ignore
@@ -15,22 +21,31 @@
 /benchmarks/                export-ignore
 /bin/                       export-ignore
 /build/                     export-ignore
+/caddy/                     export-ignore
 /captainhook.json           export-ignore
 /codecov.yml                export-ignore
+/compose.yaml               export-ignore
+/compose.yml               export-ignore
 /composer.lock              export-ignore
 /conventional-commits.json  export-ignore
+/docker-compose.yaml        export-ignore
 /docker-compose.yml         export-ignore
 /docs/                      export-ignore
+/php-development.ini        export-ignore
+/php-production.ini         export-ignore
 /phpbench.json              export-ignore
 /phpcs.xml                  export-ignore
 /phpcs.xml.dist             export-ignore
+/phpstan.dist.neon          export-ignore
 /phpstan.neon               export-ignore
-/phpstan.neon.dist          export-ignore
+/phpunit.dist.xml           export-ignore
 /phpunit.xml                export-ignore
-/phpunit.xml.dist           export-ignore
 /psalm-baseline.xml         export-ignore
 /psalm.xml                  export-ignore
+/public/                    export-ignore
 /rector.php                 export-ignore
 /resources/                 export-ignore
+/resources/                 export-ignore
 /settings.ini               export-ignore
+/storage/                   export-ignore
 /tests/                     export-ignore

.github/workflows/code_quality.yml

@@ -1,83 +1,20 @@
-name: Code Quality
+name: Code Quality Checks
 
 on:
   push:
-    branches:
-      - master
-      - develop
   pull_request:
-    branches:
-      - master
-      - develop
+    branches: [main]
 
 jobs:
-  phpcs:
-    name: PHP_CodeSniffer
+  ci:
     runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-      - name: Install PHP and Extensions
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: 8.3
-          tools: composer:v2
-      - name: Install Composer Dependencies
-        uses: ramsey/composer-install@v2
-      - name: Run PHP_CodeSniffer
-        run: vendor/bin/phpcs --no-cache
 
-  rector:
-    name: Rector
-    runs-on: ubuntu-latest
     steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-      - name: Install PHP and Extensions
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: 8.3
-          tools: composer:v2
-      - name: Install Composer Dependencies
-        uses: ramsey/composer-install@v2
-      - name: Run Rector
-        run: vendor/bin/rector process --dry-run --no-progress-bar
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-  phpstan:
-    name: PHPStan
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-      - name: Install PHP and Extensions
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: 8.3
-          tools: composer:v2
-      - name: Install Composer Dependencies
-        uses: ramsey/composer-install@v2
-      - name: Run PHPStan
-        run: vendor/bin/phpstan --no-progress --no-ansi
-
-  phpunit:
-    name: PHPUnit (PHP ${{ matrix.php }} - ${{ matrix.dependency-versions }})
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        php: [ '8.2', '8.3' ]
-        dependency-versions: [ 'locked', 'highest', 'lowest' ]
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-      - name: Install PHP and Extensions
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php }}
-          coverage: xdebug
-          tools: composer:v2
-      - name: Install Composer Dependencies
-        uses: ramsey/composer-install@v2
-        with:
-          dependency-versions: ${{ matrix.dependency-versions }}
-      - name: Run PHPUnit
-        run: vendor/bin/phpunit --no-progress --coverage-text
+      - name: Run Code Quality Checks
+        run: |
+          cp .env.dist .env;
+          sed -i "s/^GITHUB_TOKEN=.*/GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}/" ".env";
+          make -j && make ci;

.gitignore

@@ -1,8 +1,40 @@
-.idea/
+# Ignore IDE, & AI Directories
+/.aiignore
+/.cursor
+/.idea
+/.junie
+/.phpstorm.meta.php
+/.run
+/.vscode
+
+# Ignore Local, Build, Test and Vendor Directories
+/.local
+/build
+/public/local
+/public/phpunit
+/vendor
+*.terraform
+
+# Ignore environment files, except for the default distribution file
 .env
-.phpunit.result.cache
+.env.*
+*.private.env.json
+!.env.dist
+
+# Ignore boilerplate and development tooling files
 docker-compose.override.yml
+docker-compose.override.yaml
+compose.override.yml
+compose.override.yaml
+phpstan-baseline.*.neon
+phpstan-baseline.*.php
+phpstan-baseline.neon
+phpstan-baseline.php
 phpstan.neon
 phpunit.xml
-vendor/
-build/
+
+# Ignore INI Files
+*.ini
+!php-development.ini
+!php-production.ini
+

CONTRIBUTING.md

@@ -14,32 +14,32 @@ your bug report._
 When submitting a bug report, please include enough information to reproduce the
 bug. A good bug report includes the following sections:
 
-* **Description**
+- **Description**
 
-  Provide a short and clear description of the bug.
+    Provide a short and clear description of the bug.
 
-* **Steps to reproduce**
+- **Steps to reproduce**
 
-  Provide steps to reproduce the behavior you are experiencing. Please try to
-  keep this as short as possible. If able, create a reproducible script outside
-  of any framework you are using. This will help us to quickly debug the issue.
+    Provide steps to reproduce the behavior you are experiencing. Please try to
+    keep this as short as possible. If able, create a reproducible script outside
+    of any framework you are using. This will help us to quickly debug the issue.
 
-* **Expected behavior**
+- **Expected behavior**
 
-  Provide a short and clear description of what you expect to happen.
+    Provide a short and clear description of what you expect to happen.
 
-* **Screenshots or output**
+- **Screenshots or output**
 
-  If applicable, add screenshots or program output to help explain your problem.
+    If applicable, add screenshots or program output to help explain your problem.
 
-* **Environment details**
+- **Environment details**
 
-  Provide details about the system where you're using this package, such as PHP
-  version and operating system.
+    Provide details about the system where you're using this package, such as PHP
+    version and operating system.
 
-* **Additional context**
+- **Additional context**
 
-  Provide any additional context that may help us debug the problem.
+    Provide any additional context that may help us debug the problem.
 
 ## Fixing Bugs
 
@@ -60,20 +60,20 @@ your hard work, but some features don't fit with the goals of the project.
 
 When you do begin working on your feature, here are some guidelines to consider:
 
-* Your pull request description should clearly detail the changes you have made.
+- Your pull request description should clearly detail the changes you have made.
   We will use this description to update the CHANGELOG. If there is no
   description, or it does not adequately describe your feature, we may ask you
   to update the description.
-* `phoneburner/api-handler` follows a superset of **[PSR-12 coding standard][psr-12]**, and all pull requests must
+- `phoneburner/api-handler` follows a superset of **[PSR-12 coding standard][psr-12]**, and all pull requests must
   comply with the coding standard
   Please ensure your code does, too. _Hint: run `make phpcs` to check._
-* Please **write tests** for any new features you add.
-* Please **ensure that tests pass** before submitting your pull request.
+- Please **write tests** for any new features you add.
+- Please **ensure that tests pass** before submitting your pull request.
   `phoneburner/api-handler` automatically runs tests for pull requests. However,
   running the tests locally will help save time. _Hint: run `make phpunit`._
-* **Use topic/feature branches.** Please do not ask to pull from your main branch.
-    * For more information, see "[Understanding the GitHub flow][gh-flow]."
-* **Submit one feature per pull request.** If you have multiple features you
+- **Use topic/feature branches.** Please do not ask to pull from your main branch.
+    - For more information, see "[Understanding the GitHub flow][gh-flow]."
+- **Submit one feature per pull request.** If you have multiple features you
   wish to submit, please break them into separate pull requests.
 
 ## Developing
@@ -86,7 +86,7 @@ is used externally from the host environment to run most of the common scripts.
 
 After cloning this repository locally, execute the following commands:
 
-``` bash
+```bash
 cd /path/to/repository
 make
 ```
@@ -103,7 +103,7 @@ This project uses [PHPStan](https://github.com/phpstan/phpstan) to provide stati
 code. You may run static analysis manually across the whole codebase with the
 following command:
 
-``` bash
+```bash
 # Static analysis
 make phpstan
 ```
@@ -114,7 +114,7 @@ This project follows a superset of [PSR-12](https://www.php-fig.org/psr/psr-12/)
 coding standards, enforced by [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
 Rector is also used to enforce code quality and standards
 
-``` bash
+```bash
 # Run the code standards linter
 make phpcs
 
@@ -139,11 +139,7 @@ make phpunit
 ```
 
 [github]: https://github.com/PhoneBurnerOpenSource/api-handler
-
 [issues]: https://github.com/PhoneBurnerOpenSource/api-handler/issues
-
 [pull requests]: https://github.com/PhoneBurnerOpenSource/api-handler/pulls
-
 [psr-12]: https://www.php-fig.org/psr/psr-12/
-
 [gh-flow]: https://guides.github.com/introduction/flow/