Skip to content

Commit 1b79731

Browse files
committed
Configure package
1 parent 7f13136 commit 1b79731

File tree

8 files changed

+60
-234
lines changed

8 files changed

+60
-234
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Changelog
22

3-
All notable changes to :package_name will be documented in this file.
3+
All notable changes to accessible-forms will be documented in this file.

README.md

Lines changed: 44 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,48 @@
1-
# PHP Package Template
2-
3-
A repository template for Studio 24's open source PHP packages.
4-
5-
## How to use this template
6-
7-
This package can be used as to scaffold a PHP package. Follow these steps to get started:
8-
9-
1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
10-
2. Run `php ./configure.php` to run a script that will replace all placeholders throughout all the files
11-
3. Have fun creating your package.
12-
13-
## Components
14-
15-
A brief explanation of the different components of this package template.
16-
17-
- `.github/ISSUE_TEMPLATE` - GitHub issue templates
18-
- `.github/workflows` - GitHub actions for running tests (php.yml) and automated releases (release.yml)
19-
- `.github/dependabot.yml` - Dependabot configuration
20-
- `src/` - The PHP source code for your package, this will autoload based on the autoload rules in composer.json
21-
- `tests` - PHPUnit tests for your package
22-
- `.editorconfig` - Your [editor coding style](https://editorconfig.org/) configuration
23-
- `.gitattributes` - Ignore these files/folders when this package is installed via Composer
24-
- `.phpcs.xml.dist` - [PHPCodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer/) configuration
25-
- `.phplint.yml` - [PHPLint](https://github.com/overtrue/phplint) configuration
26-
- `CHANGELOG.md` - A list of notable changes, the contents of this file are automated by automated releases
27-
- `CODE_OF_CONDUCT.md` - Contributor's code of conduct
28-
- `composer.json` - Composer PHP package dependencies
29-
- `configure.php` - Package configuration script, this file is deleted once run
30-
- `CONTRIBUTING.md` - Guide to contributing
31-
- `LICENSE.md` - License information
32-
- `phpstan.neon` - [PHPStan](https://phpstan.org/) configuration
33-
- `phpunit.xml.dist` - [PHPUnit](https://phpunit.de/) configuration
34-
- `README.md` - This README file, this file is deleted once configure.php is run
35-
- `README_DEFAULT.md` - The default README file for your new package
36-
- `SECURITY.md` - Security policy for this package
1+
# This is my package accessible-forms
2+
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/studio24/accessible-forms.svg?style=flat-square)](https://packagist.org/packages/studio24/accessible-forms)
4+
[![Tests](https://img.shields.io/github/actions/workflow/status/studio24/accessible-forms/php.yml?branch=main&label=tests&style=flat-square)](https://github.com/studio24/accessible-forms/actions/workflows/php.yml)
5+
6+
This is where your description should go. Try and limit it to a paragraph or two. Consider adding a small example.
7+
8+
## Requirements
9+
10+
* PHP 8.2+
11+
12+
## Installation
13+
14+
You can install the package via [Composer](https://getcomposer.org/):
15+
16+
```shell
17+
composer require studio24/accessible-forms
18+
```
19+
20+
## Usage
21+
22+
Include some short usage instructions here. If you need more extensive docs save these in docs/ and link to them from here.
23+
24+
## Testing
25+
26+
```shell
27+
composer test
28+
```
29+
30+
## Changelog
31+
32+
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
33+
34+
## Contributing
35+
36+
Find out more about [how to contribute](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md).
37+
38+
## Security Issues
39+
40+
If you discover a security vulnerability within this package, please follow our [disclosure procedure](SECURITY.md).
41+
42+
## About
43+
44+
This package is developed by [Studio 24](https://www.studio24.net/), a human-centered digital agency who build websites and web apps that work for everyone.
3745

3846
## License
3947

4048
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
41-
42-
## Thanks to
43-
* [Spatie Package Skeleton](https://github.com/spatie/package-skeleton-php) for inspiration on package organisation and the PHP configure script

README_DEFAULT.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

composer.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"name": ":vendor_slug/:package_slug",
3-
"description": ":package_description",
2+
"name": "studio24/accessible-forms",
3+
"description": "This is my package accessible-forms",
44
"keywords": [
55
"studio24"
66
],
77
"type": "library",
88
"license": "MIT",
9-
"homepage": "https://github.com/:vendor_slug/:package_slug",
9+
"homepage": "https://github.com/studio24/accessible-forms",
1010
"require": {
1111
"php": "^8.2"
1212
},
@@ -18,12 +18,12 @@
1818
},
1919
"autoload": {
2020
"psr-4": {
21-
"VendorName\\PackageTemplate\\": "src"
21+
"Studio24\\AccessibleForms\\": "src"
2222
}
2323
},
2424
"autoload-dev": {
2525
"psr-4": {
26-
"VendorName\\PackageTemplate\\Tests\\": "tests"
26+
"Studio24\\AccessibleForms\\Tests\\": "tests"
2727
}
2828
},
2929
"scripts": {

configure.php

Lines changed: 0 additions & 131 deletions
This file was deleted.

src/AccessibleForms.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Studio24\AccessibleForms;
6+
7+
class AccessibleForms
8+
{
9+
}

src/ExampleClass.php

Lines changed: 0 additions & 9 deletions
This file was deleted.

tests/ExampleTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
declare(strict_types=1);
44

5-
namespace Studio24\PackageTemplate\Tests;
5+
namespace Studio24\AccessibleForms\Tests;
66

77
use PHPUnit\Framework\TestCase;
88

0 commit comments

Comments
 (0)