Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING.md for Review Apps #462

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Update CONTRIBUTING.md for Review Apps #462

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f60c29f
Update CONTRIBUTING.md for Review Apps
Polynya Jul 10, 2024
4fbba88
Update CONTRIBUTING.md
Polynya Oct 17, 2024
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
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,21 @@ 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

## 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