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:
- Always retain backwards compatibility, unless a breaking change is necessary. If it is necessary, the associated release notes must make this explicit and obvious;
- Make every effort to follow existing conventions and style;
- Follow PEP8;
- Follow the Google Python Style Guide for docstrings;
- Use spaces, not tabs;
- Update the rez version appropriately, and follow semantic versioning;
- Use this format to mention the issue(s) your PR closes;
- Add relevant tests to demonstrate that your changes work;
- Add relevant documentation here to document your changes, if applicable. Those
markdown files prefixed with
_are internal and should not be changed. - If you changes add a new rez config setting, update rezconfig.py and document the setting. The comments in this file are extracted and turned into Wiki content. Pay attention to the comment formatting and follow the existing style closely.
The Windows tests currently build a Python image for each version to test. Each is based on a common base image. Any changes to the following Docker images sources should be a separate commit:
.github/docker/rez-win-base/**.github/docker/rez-win-py/**.github/workflows/windows-docker-image.yaml
The base and Python images will be automatically rebuild.
Any future commits will pickup the correct image via windows-docker.yaml
If you report a bug, please ensure to specify the following:
- Rez version (e.g. 2.18.0);
- Platform and operating system you were using;
- Contextual information (what were you trying to do using Rez);
- Simplest possible steps to reproduce.