From f60c29f0e866d77cd1fd670b57b2b158d8488bcb Mon Sep 17 00:00:00 2001 From: Adrian Bateman Date: Wed, 10 Jul 2024 11:39:00 +0100 Subject: [PATCH 1/2] Update CONTRIBUTING.md for Review Apps --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa89eaa5..ab9c5b15 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,3 +58,14 @@ purpose of the change can be traced. Multiple commits in a pull request should be squashed unless the individual commit messages are informative. + +## Review Apps +An environment can be created from a pull request for testing a new feature before it is merged. + +### Commands in a comment +#### /start +Start Review App +#### /rebuild +Rebuild the Review App (without resetting the database) +#### /stop +Stop Review App and clear up From 4fbba88ab2dd0ca08225373df7fa1e4152f1a7f1 Mon Sep 17 00:00:00 2001 From: Adrian Bateman Date: Thu, 17 Oct 2024 16:18:24 +0100 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ab9c5b15..d0ab2ffe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,3 +69,10 @@ Start Review App Rebuild the Review App (without resetting the database) #### /stop Stop Review App and clear up + +## Code quality +These are useful commands to run before trying to run a Review App: + +- `composer phpcs` - run CodeSniffer +- `composer phpcbf` - fix some CodeSniffer issues +- `composer tests-required` - run CodeSniffer and check for security updates - this is run in the pipeline