Skip to content

[RFC]: stdlib-bot should comment on Pre-Commit and Pre-Push Report Anomalies #46

@Planeshifter

Description

@Planeshifter

This RFC proposes adding a GitHub Actions workflow to detect missing YAML blocks or dependencies in commit messages, ensuring contributors have correctly set up their development environment.

Automating the detection of setup issues and missing dependencies helps maintain code quality and provides immediate feedback to contributors.

Specifically, we need to detect in a GitHub actions workflow whether either a) these YAML blocks are missing completely, in which case contributors haven't set up their environment correctly, or whether some dependencies might be missing. When such a case is encountered, the @stdlib-bot should leave an appropriately tailored comment on the issue with instructions for how to either a) set up dev environment properly in the first place or b) install the respective missing tools.

Detection

  1. Missing YAML Blocks: Identify if pre_commit_static_analysis_report or pre_push_report blocks are absent from commit messages.
  2. Missing Dependencies: Check for missing_dependencies status in tasks.

Time to completion without AI: 3h
Time to completion with AI: 2h

Metadata

Metadata

Assignees

Labels

FeatureTask to add a new feature.difficulty: 2May require some initial design or R&D, but should be straightforward to resolve and/or implement.estimate: 2-4hrsTask which should take between 2 to 4 hours.🤖 AIAllowed to use AI.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions