Skip to content
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

Collect metadata on each program #4

Open
briandfoy opened this issue Sep 22, 2014 · 5 comments
Open

Collect metadata on each program #4

briandfoy opened this issue Sep 22, 2014 · 5 comments
Labels
Priority: backlog not working on this, unless someone else wants to Type: documentation fix the docs

Comments

@briandfoy
Copy link
Owner

Collect meta data for all the programs. Store them in a consistent way in the program for now.

See the bin/factor program for a start. See the top =pod section

@ghost
Copy link

ghost commented Oct 28, 2016

@briandfoy close this issue? Looks like this was already handled via #8. Unless you're looking for something more

@briandfoy
Copy link
Owner Author

I'd like to fill in the holes in many of the entries.

@ghost
Copy link

ghost commented Oct 29, 2016

Fair enough, I can perhaps take a look around sometime next week to see what's missing

@briandfoy briandfoy added Type: documentation fix the docs Priority: backlog not working on this, unless someone else wants to labels Mar 9, 2023
@jgpuckering
Copy link
Contributor

Brian,

I whipped up a script to extract the metadata and print it as a tab-separated table for review in Excel. Here's what I found:

Missing Authors:  tar, tty

Missing email addresses:
  Brad Appleton       test
  Jeffrey S. Haemer   addbib, asa, clear, colrm, mkfifo, tsort, uname
  Joshua Gross        date
  Louis Krupp         mkfifo
  Michael Mikonos     base64, hexdump, morse
  Paul Grassie        grep
  dkulp               ar, file, time

Non-standard email:
  Nathan Scott Thompson, "quimby at city-net dot com"
  (in deroff, strings)

Missing license:
  arch, dc, expr, hexdump, id, kill, mimedecode, 
  ppt, strings, sum, tar, tty, whois, xargs

Some of these holes can be plugged. For example, I found an email for Brad Appleton in CPAN -- but without verification it might be pointless to add it. But I'd be happy to go through that process.

Nathan Scott Thompson has a email but it's inconsistent with the rest. Easy to fix.

Speaking of inconsistencies, the Description for rot13 starts with a propercase word. All others are lowercase. I'd like to change it to lowercase.

I didn't actually validate the License info. I suspect you already did that, but if you'd like an independent review checking the metadata entry against the POD in the file, I can do that.

As for the missing licenses, most show as perl_5 in MetaCPAN -- probably the default. Not sure whether the files should be updated accordingly. Most of these are so old that it seems likely they never had any license information. Is it valid to add it now??? At Cognos and then IBM I used to do compliance work, including some related to copyright. It's a complex area. Nonetheless, it seems to me that if the code is published via MetaCPAN and a license is listed on the page, and most scripts include said license, then all should. What are your thoughts on that?

As for scripts that are missing metadata, I only found two: base64 and hexdump. I have an update for those.

I see you've already released 1.035 with my changes. That's great! Let me know if you'd like me to tackle any of the above tasks so this ticket can be closed. After that I may look into the other tickets.

  • Gary

@briandfoy
Copy link
Owner Author

  • If someone didn't declare a license, I leave it blank. perl_5 is probably a good choice if it's absent. I emailed most people I find to ask if they had a preference and filled in their answers. If you can carry that forward, go for it.

  • For everything else, it sounds like you have a good plan. For those, though, I'd prefer small, targeted pull requests that deal with single issues (say "Fixes licenses") instead of a big change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: backlog not working on this, unless someone else wants to Type: documentation fix the docs
Projects
None yet
Development

No branches or pull requests

2 participants