Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.25 KB

CONTRIBUTING.adoc

File metadata and controls

27 lines (19 loc) · 1.25 KB
Raw

Guidelines for contributing to ue4-docker

Table of Contents

Creating issues

When creating an issue to report a bug, please follow the provided issue template. Make sure you include the full output of the ue4-docker info command in the provided section, as well as the full output of the ue4-docker build command and the command line parameters used to invoke the build if you are reporting a problem with building the container images.

If you are creating an issue for a feature request, you can disregard the default issue template. However, please make sure you have thoroughly read the documentation to ensure the requested feature does not already exist before creating an issue.

Creating pull requests

Before creating a pull request, please ensure sure you have tested your changes on all platforms to which the change applies (Linux / Windows Server / Windows 10 / macOS).

Autoformatting your changes

ue4-docker uses Black for its code formatting. If you are submitting changes, make sure to install and run Black:

  • pip install --user black

  • python -m black . (invoke in repository root)

  • Now your code is properly formatted