Welcome to VIP! This repo is a starting point for building your VIP Go site, including all the base folders to be built on.
| Environment | Branch | URL |
|---|---|---|
| Production | master | https://example.com |
| Staging | staging | https://staging.example.com |
| Development | develop | https://dev.example.com |
| Name | Github Username |
|---|---|
| Name | @github_username |
| Name | Github Username |
|---|---|
| Name | @github_username |
- Complete the features or bug fixes locally and push the branch to the GitHub repo.
- Raise a pull request (PR) against the develop branch.
- Assign that PR to Developer/EM for internal code review. If any code review feedback, the team needs to address it and push changes, update PR, and re-request code review.
- PR approved: Merge that into the develop branch and it will deploy to the development site. You can review the feature there.
- Perform internal QA on the development site.
- Follow the same steps to deploy the changes on QA (preprod) site. Code review is not required.
- Client will do the UAT on the QA site and they will approve.
- Once approved, you can raise the PR against the master branch and assign a PR to Developer/EM/VIP team for the final code review.
- PR approved: you can merge and it will deploy to the production site.
master
- For feature -
feature/issue-nameFor example,feature/add-plugin - For bug -
fix/issue-nameFor example,fix/phpcs-errors
- Title should be same as Issue title. Also add issue number before title. For example,
#3 Setup initial theme. - Add proper description.
- Assign code reviewer and project.
- Create draft pull request for work in-progress PR and don't add
WIP:in PR title. - PR should have one approval.
We'd recommend starting with one of the following guidebooks. They include everything you need to know about launching and developing with VIP:
To dig straight into our documentation and get up and running, try:
All the following directories are required and must not be removed:
client-mu-plugins: for always active, global plugins (similar tomu-plugins) — see our documentation for more information.images: Store your site's favicons here, per this documentation. All other public-facing images should be uploaded or imported to the WordPress dashboard or stored as part of your/theme/assets.languages: For.poand.motranslation files, which specify the translated strings for the site — more details here.plugins: Your site's plugins — more details here.private: Provides access to files that are not directly web accessible, but can be accessed by your theme or plugin code — more details here.themes: Themes to be made available to your sites – more details here. We recommend keeping the default theme available for testing purposes.vip-config: For custom configuration changes and additionalsunrise.phpdetails. This folder’svip-config.phpfile is used in place ofwp-config.php. More details here.
These directories will also be available on production web servers. Any additional directories created in your GitHub repository that are not included in the above list will not be mounted onto your site, and so will not be web-accessible.
If you need help with anything, VIP's support team is just a ticket away.
Feel free to add to or replace this README.md content with content unique to your project, for example:
- Project-specific notes; like a list of VIP environments and branches,
- Workflow documentation; so everyone working in this repo can follow a defined process, or
- Instructions for testing new features.