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

Automate linting in pull requests and annotate PR diffs with linter reports #2111

Open
14 tasks
rija opened this issue Nov 28, 2024 · 0 comments
Open
14 tasks

Comments

@rija
Copy link
Contributor

rija commented Nov 28, 2024

User story

As a developer
I want linting of submitted code to be automated
and to have their reports annotate the PR file diffs
So that code quality of PR submissions are automatically assessed without extra work needed

Acceptance criteria

Given a file from a PR is in PHP
When the PR is created
Then linting is run by Github actions for this file

Given a file from a PR is in Javascript
When the PR is created
Then linting is run by Github actions for this file

Given a file from a PR is in Bash
When the PR is created
Then linting is run by Github actions for this file

Additional Info

Use github actions on PR

PHP:
https://github.com/marketplace/actions/phpcs-check-with-annotations

Javascript:
https://github.com/marketplace/actions/eslint-annotate-from-report-json

Shell:
https://github.com/marketplace/actions/shellcheck

Product Backlog Item Ready Checklist

  • Business value is clearly articulated
  • Item is understood enough by the IT team so it can make an informed decision as to whether it can complete this item
  • Dependencies are identified and no external dependencies would block this item from being completed
  • At the time of the scheduled sprint, the IT team has the appropriate composition to complete this item
  • This item is estimated and small enough to comfortably be completed in one sprint
  • Acceptance criteria are clear and testable
  • Performance criteria, if any, are defined and testable
  • The Scrum team understands how to demonstrate this item at the sprint review

Product Backlog Item Done Checklist

  • Item(s) in increment pass all Acceptance Criteria
  • Code is refactored to best practices and coding standards
  • Documentation is updated as needed
  • Data security has not been compromised (with particular reference to the personal information we hold in GigaDB)
  • No deviation from the team technology stack and software architecture has been introduced
  • The product is in a releasable state (i.e. the increment has not broken anything)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: To Estimate
Development

No branches or pull requests

1 participant