processing / processing/processing-contributions

Automate reporting for BROKEN libraries

Open
#70 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
8
Forks
8
Avg merge
4d 22h
Merged PRs (30d)
3

Description

Right now, broken contributions are only visible in contributions.yaml through the status: BROKEN flag.

If a contribution go missing, we have to wait for someone to report that they don't appear in the contribution manager (like here for example)

It would be helpful to automate the reporting process when a library is first marked as BROKEN.

For example, we could open an issue automatically when a library is reported as BROKEN for the first time.

On a related note, we could add optional fields in contributions.yaml and submission issue template for the repository URL and GitHub username(s) of the author(s). This would make it easier to tag maintainers when their contribution goes down.

Would love to hear thoughts on this. Happy to help if we decide to move forward!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing contributions.yaml and the submission issue template, then trace the repository's Python scripts that convert the contribution list for the PDE Contribution Manager and website. Determine how a first BROKEN status can trigger one report and how maintainer repository and username fields should flow through the process. Done means the reporting and optional metadata behavior are specified and covered by appropriate checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.