You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-29Lines changed: 21 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,25 @@
1
1
# Contributing to the Unity Web Portal
2
2
3
-
## Branch Structure
4
-
5
-
Each release version has its own branch. Once that version is released, the branch is locked.
6
-
7
-
When submitting pull requests, the pull request should be made to the version you are targetting, assuming it is not already released.
8
-
9
3
## Conventions
10
4
11
-
This code base is currently using PHP version 7.4. All files are required to be linted with PSR-12 standard. This repository will automatically check PRs for linting compliance.
5
+
This code base is currently using PHP version 8.3.
6
+
All files are required to be linted with PSR-12 standard.
7
+
This repository will automatically check PRs for linting compliance.
12
8
13
9
## Development Environment
14
10
15
11
### Setting up your Environment
16
12
17
-
1. Download and install [docker desktop](https://www.docker.com/products/docker-desktop/) for your appropriate OS.
18
-
1. In `tools/docker-dev` Run the build script: `./build.sh` (mac os/linux) or `./build.bat` (windows)
19
-
1. Run the environment: `./run.sh` (mac os/linux) or `./run.bat` (windows). Press `CTRL+C` to exit.
13
+
1. Clone this repo (including submodules): `git clone <this-repo> --recurse-submodules`
14
+
1. install composer
15
+
1. install PHP dependencies: `composer update`
16
+
1. If you're on Windows, use WSL
17
+
1. Download and install [docker desktop](https://www.docker.com/products/docker-desktop/)
18
+
1. In `tools/docker-dev` Run the build script: `./build.sh`
19
+
1. Run the environment: `./run.sh`. Press `CTRL+C` to exit
20
+
1. If you bork your LDAP or SQL server, just run `./build.sh` again
21
+
1. Install pre-commit
22
+
1. setup pre-commit: `pre-commit install`
20
23
21
24
### Environment Usage
22
25
@@ -29,25 +32,14 @@ While the environment is running, the following is accessible:
29
32
30
33
### Test Users
31
34
32
-
The test environment ships with a number of users that can be used for testing. When accessing locked down portions of the portal, you will be asked for a username and password. The password is always `password`.
33
-
34
-
The following users are available for testing:
35
-
36
-
*`[email protected]` - admin user who is a member of pi_user1_domain_edu
0 commit comments