qiskit-community/qiskit-metriq

Improve automated pull requests

Open

#49 opened on Feb 9, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (3 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The automated workflow of this project includes opening automated PRs in case a new Qiskit version is found. The automated PR adds new csv results for experiments on new Qiskit versions. This job would benefit from improvements as listed below:

  • include automation keyword in the PR title
  • add qiskit version update in the PR description or commit message (eg. from qiskit vx to qiskit vy)
  • don't add tox.ini file changes (tox configs are dynamically created for specific qiskit versions)
  • summary.json still needs to be manually cleaned up (eg. replace summary results from qiskit version x.y.z1 with latest patch x.y.z2)

Contributor guide

Research direction
Examine the existing GitHub Actions workflow files in the repository to understand the current automated PR creation process and implement the checklist items.
Tech stack
python
Domain
devopsbackend
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60