Skip to content

Commit

Permalink
Add initial version of development environment docs
Browse files Browse the repository at this point in the history
Signed-off-by: Bryce Gattis <[email protected]>
  • Loading branch information
BryceGattis committed Feb 11, 2024
1 parent a11b8ce commit b8753c7
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
# Contributing To Rez

## Development Environment

### Prerequisites

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),
otherwise the PowerShell tests will fail.

### Setting Up

To begin development on Rez you'll first need to set up your development environment. There are many
ways you can do it, but this is the recommended approach.

1. Fork the repo and clone it.
2. Create a new Git branch and check it out.
3. Create a virtual environment in the same directory as the repo by running `python -m venv venv`.
4. Pip install your local Rez code by running `pip install .`

### Running Tests

1. Set up your development environment as shown above.
2. Run `rez selftest`.

## Guidelines

If you would like to contribute code you can do so through GitHub by forking the repository and
sending a pull request. Please follow these guidelines:

Expand Down

0 comments on commit b8753c7

Please sign in to comment.