Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

42 lines (31 loc) · 2.4 KB

Contributing To Rez

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:

  1. Always retain backwards compatibility, unless a breaking change is necessary. If it is necessary, the associated release notes must make this explicit and obvious;
  2. Make every effort to follow existing conventions and style;
  3. Follow PEP8
  4. Follow the Google Python Style Guide for docstrings
  5. Use spaces, not tabs;
  6. Update the bleeding-rez version appropriately, and follow semantic versioning;
  7. Update the changelog; see the section below for more details
  8. Use this format to mention the issue(s) your PR closes
  9. Add relevant tests to demonstrate that your changes work
  10. Add relevant documentation (see here) to document your changes, if applicable.

Reporting Bugs

If you report a bug, please ensure to specify the following:

  1. Rez version (e.g. 2.18.0);
  2. Platform and operating system you were using;
  3. Contextual information (what were you trying to do using Rez);
  4. Simplest possible steps to reproduce.

Updating The Changelog

Here is an example changelog entry:

## [2.30.0](https://github.com/mottosso/bleeding-rez/tree/2.30.0) (2019-05-07)
[Full Changelog](https://github.com/mottosso/bleeding-rez/compare/2.29.1...2.30.0)

**Closed issues:**

- rezbuild.py broken [\#619](https://github.com/mottosso/bleeding-rez/issues/619)
- bleeding-rez-env Performance and socket.getfqdn() [\#617](https://github.com/mottosso/bleeding-rez/issues/617)
- "parse_build_args.py" file parser arguments are not accessible anymore in "os.environ". [\#590](https://github.com/mottosso/bleeding-rez/issues/590)

Please include the relevant issues that your PR closes, matching the syntax shown above. When the PR is merged to master, the PR info will be added to the same changelog entry by the maintainer. Don't be too concerned with the date and 'full changelog' line, this will also be patched by the maintainer.