Skip to content

Commit 386a106

Browse files
authored
Update README.md
1 parent 1566088 commit 386a106

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Reusable GitHub Actions workflow for testing phpBB extensions across multiple environments.
44

5-
This repository provides a pre-configured test workflow designed for phpBB extension developers. It runs your extension's tests using various PHP versions and database systems, including **MySQL**, **PostgreSQL**, **SQLite**, and **Microsoft SQL Server**.
5+
This repository contains a pre-configured test workflow designed for phpBB extension developers. It runs your extension's tests using various PHP versions and database systems, including **MySQL**, **PostgreSQL**, **SQLite**, and **Microsoft SQL Server**.
66

77
## 🚀 Features
88

@@ -24,7 +24,7 @@ Use the branch that matches the phpBB version you're developing for.
2424

2525
## 📦 How to Use
2626

27-
On GitHub.com, go to your repository, click **Add file → Create new file**, name it `.github/workflows/tests.yml`, add the workflow content shown below, and commit the file. Make sure to replace `acme/demo` with your actual extension vendor/package name, and optionally you may adjust any of the branch names and other checks.
27+
On GitHub.com, go to your extension's repository, click **Add file → Create new file**, name it `.github/workflows/tests.yml`, add the workflow content shown below, and commit the file. Make sure to replace `acme/demo` with your actual extension vendor/package name, and optionally you may adjust any of the branch names and other checks.
2828

2929
```yaml
3030
name: Tests
@@ -60,7 +60,7 @@ jobs:
6060
6161
## ✅ Requirements
6262
63-
- Your extension must follow standard phpBB extension structure.
63+
- Your extension's package contents must be located at the root level of the repository. That is, the repository **must directly represent the package**, with all relevant files such as `composer.json`, `README`, `LICENSE`, etc. placed directly in the **root of the repository**, **not inside a subdirectory within the repository**. See any of phpbb-extension's official extension repositories as an example.
6464
- Tests must be defined in your repository using PHPUnit.
6565

6666
## ⏭️ Skipping Jobs

0 commit comments

Comments
 (0)