Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/php.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
php:
php:
- '8.2'
- '8.3'
- '8.4'

steps:
- name: Checkout repository
Expand Down
28 changes: 10 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,17 @@ This repository makes it easier to develop a PHP application or library by provi
## Getting started

### Creating a new repository
Choose a method:
- **GitHub UI**: Press the "Use this template" button in the top-right corner of this page.
- **GitHub CLI**: Install [GitHub CLI](https://cli.github.com). Then run one of the following:
```shell
gh repo create --template neoncitylights/php --public --clone {{repository}} # clone as public
gh repo create --template neoncitylights/php --private --clone {{repository}} # clone as private
```

#### GitHub UI
### Replace placeholders

You can create a new repository based on this template by clicking the "Use this template" button in the top-right corner of this page.

#### Terminal

You can run the following command below with the [GitHub CLI](https://cli.github.com/). Some notes:

- Replace placeholder with name of your extension in upper CamelCase
- Configure your repository's visibility with `--public`, `--private`, or `--internal`

```shell
gh repo create {repo-name} --public --clone --template neoncitylights/php-template
```

### Cookiecutter stuff

Using your favorite text editor or IDE, find-and-replace the following placeholders:
Using your text editor or IDE, find-and-replace the following placeholders:

- `{repo-name}`: Replace with the name of your repository
- `author/package`: Replace with your own author and package name.
Expand All @@ -56,7 +48,7 @@ Delete this `README.md`, and rename [`LIBRARY.md`](./LIBRARY.md) to `README.md`.
| ---- | ---- | ------------- |
| Composer package | [`composer.json`](./composer.json) | [docs](https://getcomposer.org/doc/04-schema.md), [website](https://getcomposer.org/), [repo](https://github.com/composer/composer) |
| PHPCS (formatter + linter) | [`.phpcs.xml`](./.phpcs.xml) | [docs](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#using-a-default-configuration-file), [repo](https://github.com/squizlabs/PHP_CodeSniffer) |
| PHPUnit (unit testing) | [`.phpunit.xml.dist`](./.phpunit.xml.dist) | [docs](https://phpunit.readthedocs.io/en/10.1/configuration.html), [website](https://phpunit.de/), [repo](https://github.com/sebastianbergmann/phpunit) |
| PHPUnit (unit testing) | [`.phpunit.xml.dist`](./.phpunit.xml.dist) | [docs](https://phpunit.readthedocs.io/en/11.5/configuration.html), [website](https://phpunit.de/), [repo](https://github.com/sebastianbergmann/phpunit) |
| phpdoc (documentation generator) | [`phpdoc.dist.xml`](./phpdoc.dist.xml) | [docs](https://docs.phpdoc.org/3.0/guide/references/configuration.html), [website](https://www.phpdoc.org/), [repo](https://github.com/phpdocumentor/phpdocumentor) |
| Dependabot | [`.github/dependabot.yml`](./.github/dependabot.yml) | [docs](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file), [website](https://github.com/dependabot) |

Expand Down
Loading