Repository navigation
Add licensing, source location, and GitHub handle information to properties #87
Description
Activity
- changed the title
[-]add licensing information to properties[/-][+]Add licensing, source location, and GitHub handle information to properties[/+]on May 8, 2025 @mingness I've updated the issue above to reflect our conversation in processing/processing-contributions#70
Let me know what you think!
Is it possible to not assume GitHub is used? It's not the only platform for hosting git repos. I guess currently the automation is designed for GitHub, right? In that case I guess a GitHub user is probably a must. I was just thinking that it would be nice to allow alternatives.
Hey @hamoid, thanks for raising that.
Right now I have to manually track people down when their library breaks or disappears. The idea behind collecting GitHub usernames (as an optional field) is to make that easier in the future if we want to ping maintainers. Since we are managing contributions on this GitHub repository, usernames felt like useful information to ask for, but you're right that it assumes GitHub. We could clarify in the comments what this information will be used for, and offer the option to include an email address.
How about revising this section like so:
# If your library becomes broken, outdated, or unavailable, this information helps # us reach out to you. Providing a GitHub username or email address is optional, # but strongly encouraged to make maintenance easier in the future. # # Note: This information will be publicly visible on the processing-contributions # repository # # (We will only use this information to contact you about issues related to your library.) # (Optional) Comma-separated list of maintainer GitHub usernames. githubUsernames= # (Optional) Contact email address maintainerEmail=
Let me know what you think.
Not sure how to name it, but if it was something like gitUserURL, it would allow for https://gitlab.com/myUser or https://codeberg.org/myUser (although I don't know how would one actually contact the person... opening an issue in a random repo of theirs? 😅).
Asking for an e-mail sounds good. It would be nice if the list was not scrapable by bots.
- We kinda already ask for email in the authors field - we could be more specific there perhaps…On Thu, May 8, 2025, 21:56 Abe Pazos ***@***.***> wrote: *hamoid* left a comment (processing/processing-library-template#87) <#87 (comment)> Not sure how to name it, but if it was something like gitUserURL, it would allow for https://gitlab.com/myUser or https://codeberg.org/myUser (although I don't know how would one actually contact the person... opening an issue in a random repo of theirs? 😅). Asking for an e-mail sounds good. It would be nice if the list was not scrapable by bots. — Reply to this email directly, view it on GitHub <#87 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABLIT5LXKXIWVNCKRPAKOX325PAGDAVCNFSM6AAAAAB4TLK77OVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQNRUGI4TCNJXGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>
Describe the feature or enhancement
As suggested in processing/processing-contributions#67, we could add an additional property for the library's license, suggesting the same license that Processing uses, LGPL v2.1.
Additionally, we could add optional properties for the repository URL and GitHub username(s) of the author(s) to
release.properties.Example
What is the use case?
Adding license information would allow us to provide users with clear information about the licensing terms of libraries, tools, and modes available in the Contribution Manager.
Adding repository and GitHub usernames would make it easier to contact authors if a library becomes broken or outdated, and allow for listing multiple maintainers properly.
Alternatives considered
No response