ffyhlkain/projectauditor

Project Auditor is an experimental static analysis tool for Unity Projects.

Project Auditor

Project Auditor is a static analysis tool that analyzes assets, settings, and scripts of the Unity project and produces a report containing: Code and Settings diagnostics, the last BuildReport, and assets information.

Disclaimer

This package is available as an experimental package, so it is not ready for production use. The features and documentation in this package might change before it is verified for release.

Feedback, bug reports and feature requests are more than welcome, please enter them here.

Installation

The simplest way to install Project Auditor is to clone the repository to the Packages folder of your project. Alternatively, it is possible to clone the repository to a different folder. However, note that in this case you will have to add com.unity.project-auditor to your Packages/manifest.json.

License

Project Auditor is licensed under the Unity Package Distribution License as of November 18th 2020. Before then, the MIT license was in play.

Documentation

For information on how to install and use Project Auditor, please refer to the documentation.

Development

Here are the steps required to setup a Unity project for Project Auditor development.

Tests

In order to be able to run (existing or new) tests in VS/Rider or within Unity using TestRunner, it is necessary to:

• Install Test Framework from Package Manager.
• Add the following lines to your Packages/manifest.json:

 "testables": [
    "com.unity.project-auditor"
  ]

Pull Requests

1. Start a new pull request on GitHub.
2. Describe the problem you are trying to solve.
3. Describe the solution you are trying to implement.
4. Add mtrive as reviewer to the pull request.
5. Create the pull request.
6. Once approved, select Squash and merge and delete the remote branch.

Note: Make sure to select Unity-Technologies/ProjectAuditor as base repository and master as base branch when creating the Pull Request.

The repository owners are committed to maintaining this repository and ensuring that it continues to adhere to Unity Standards for package development. Individual pull requests may take time to be approved if they contain changes that require the package to be re-validated.