Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align "code review" documentation with industry terminology #378

Open
rmccue opened this issue Dec 19, 2024 · 0 comments
Open

Align "code review" documentation with industry terminology #378

rmccue opened this issue Dec 19, 2024 · 0 comments
Labels
developer advocacy Developer Advocacy related tasks

Comments

@rmccue
Copy link
Member

rmccue commented Dec 19, 2024

Our current code review guide has a bit of path dependency, where we call it code review because we started with human peer review. However, this doesn't really align with industry terminology around this sort of tooling, and it's unclear why we have it.

Firstly, we should move this section into the security module to make it clear that it's part of our security assurance suite (there's performance too).

Secondly, we should align our terminology and re-emphasise the "code review" phrasing in favour of terms like static analysis and static application security testing (SAST).

Thirdly, we should reframe the entire value pitch and core of the documentation to focus on the security suite as a whole. That is, we should talk about static analysis (linting rules), dependency security (dependabot), and software development lifecycle (SDLC) tools (deployments); these can then link across to our other docs for each of these parts.

Fourth...ly? (Not sure that's a word.) We should reframe the static analysis page to talk more about the existence of the phpcs rules than altis-review specifically, and offer two options for using it (1: rules via phpcs, maybe mention running in GitHub Actions; 2: altis-review bot)

@rmccue rmccue added the developer advocacy Developer Advocacy related tasks label Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer advocacy Developer Advocacy related tasks
Projects
None yet
Development

No branches or pull requests

1 participant