-
Notifications
You must be signed in to change notification settings - Fork 5
Automate reporting for BROKEN libraries #70
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
Comments
Great idea @SableRaf , it would really help keep an eye on the state of the contributions. with regards to the optional field for the github username in the issue template, which is then added to the contributions.yaml, that sounds good to me. |
Thanks @mingness! I made a PR to update the issue templates, but then realized that since we generate We could add the following to # (Optional) A URL to the source repository for your library (e.g., https://github.com/yourUser/yourLibrary).
repository_url=
# (Optional) Your GitHub username. Useful for linking contributions.
github_username=
# (Optional) The SPDX identifier for your library's license (e.g., LGPL-2.1-or-later).
license_spdx= Then could add optional properties to # Define a mapping of properties to YAML fields
optional_fields = {
'repository_url': 'repositoryUrl',
'github_username': 'githubUsername',
'license_spdx': 'licenseSpdx',
}
# Add optional fields if present
for prop_key, yaml_key in optional_fields.items():
value = props.get(prop_key)
if value:
props[yaml_key] = value
del props[prop_key] Let me know if I'm on the right track! |
Right now, broken contributions are only visible in
contributions.yaml
through thestatus: 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!
The text was updated successfully, but these errors were encountered: