Proposed RFC Feature: Static Analysis via GitHub Actions #21
Labels
good first issue
Good for newcomers
priority/major
Major priority. Work that should be handled after all blocking and critical work is done.
rfc-feature
Request for Comments for a Feature
triage/accepted
Issue that has been accepted and is ready for work
Summary:
Static Analysis tool(s) could execute during Automated Review OR periodically run and auto-cut issues based on the findings. Static analysis tools exist in GitHub actions, which O3DE has "free" credits for executing as part of being an open source project: https://github.com/marketplace/category/code-quality . Determine which are appropriate to run, and propose the cadence they should run.
TODO: This RFC is a stub, and needs to be further defined before it is ready for comment and further revision. Fill out the sections below, and bring this document to review with SIG-Testing
What is the relevance of this feature?
Why is this important? What are the use cases? What will it do once completed?
Feature design description:
Explain the design of the feature with enough detail that someone familiar with the environment and framework can understand the concept and explain it to others.
It should include at least one end-to-end example of how a developer will use it along with specific details, including outlying use cases.
If there is any new terminology, it should be defined here.
Technical design description:
Explain the technical portion of the work in enough detail that members can implement the feature.
Explain any API or process changes required to implement this feature
This section should relate to the feature design description by reference and explain in greater detail how it makes the feature design examples work.
This should also provide detailed information on compatibility with different hardware platforms.
What are the advantages of the feature?
What are the disadvantages of the feature?
How will this be implemented or integrated into the O3DE environment?
Are there any alternatives to this feature?
How will users learn this feature?
Are there any open questions?
The text was updated successfully, but these errors were encountered: