Skip to content

Commit b8753c7

Browse files
committed
Add initial version of development environment docs
Signed-off-by: Bryce Gattis <[email protected]>
1 parent a11b8ce commit b8753c7

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# Contributing To Rez
22

3+
## Development Environment
4+
5+
### Prerequisites
6+
7+
On Windows, make sure to set your PowerShell execution policy as shown [here](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-5.1),
8+
otherwise the PowerShell tests will fail.
9+
10+
### Setting Up
11+
12+
To begin development on Rez you'll first need to set up your development environment. There are many
13+
ways you can do it, but this is the recommended approach.
14+
15+
1. Fork the repo and clone it.
16+
2. Create a new Git branch and check it out.
17+
3. Create a virtual environment in the same directory as the repo by running `python -m venv venv`.
18+
4. Pip install your local Rez code by running `pip install .`
19+
20+
### Running Tests
21+
22+
1. Set up your development environment as shown above.
23+
2. Run `rez selftest`.
24+
25+
## Guidelines
26+
327
If you would like to contribute code you can do so through GitHub by forking the repository and
428
sending a pull request. Please follow these guidelines:
529

0 commit comments

Comments
 (0)