Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (21 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.43 KB
Raw

Contributing

Thanks for helping improve Engine Sim Unity Audio.

Before opening an issue

  • Search existing issues first.
  • For a build or generation problem, run Generate-All.ps1 -ProbeOnly and include the relevant non-sensitive output.
  • Include the preset name, entry function, Windows version, Visual Studio version, and CMake version when they matter.

Pull requests

  1. Create a focused branch from main.

  2. Keep generated output, build, and bin out of commits.

  3. Run the checks below before opening the pull request:

    & .\Build-Generator.ps1
& .\Generate-All.ps1 -ProbeOnly

  4. Explain the problem, the approach, and how you verified the change.

  5. Update the README, changelog, or attribution notices whenever a user-facing workflow, dependency, or license changes.

Third-party code and presets

Do not replace, reformat, or expand the vendored Engine Simulator runtime unless it is necessary for the headless generator. Document every intentional vendor change in ThirdParty/PATCHES.md, preserve upstream notices, and keep the change narrowly scoped.

Only submit engine definitions and other assets that you are allowed to redistribute. State the source and license in the pull request when they are not original work.

Conduct and security

Please follow CODE_OF_CONDUCT.md. Do not open a public issue for a security concern; use the process in SECURITY.md.