Help with attribution for tests
Closed this issue · 5 comments
@briandfoy -- I am sorry for using an issue for this. I am happy to move this discussion elsewhere if helpful.
My question is: how would you prefer your test files to be attributed if I use them in Mac::PropertyList::SAX
?
I would like to use kulp/Mac-PropertyList-SAX#4 to incorporate your improved tests, verbatim wherever possible, particularly covering functionality that was added to Mac::PropertyList
since my implementation of Mac::PropertyList::SAX
. As you may know, I have been using modified versions of them for years, with unfortunately-worded "Stolen from ..." comments, and I would like to do better.
I was thinking of including a README.md
file in the t/
directory to point at your repository. Can you suggest better content for that file, or a different idea?
Since both your project and mine are licensed under the same terms as Perl (although mine only says so in POD, so far), I think this is a question more of good practice than of licensing per se, but please let me know your thoughts.
Thank you.
I think attribution in each file is probably the best. I can update the test files and then you can just copy them. It might take me a couple weeks to get to this though.
I can update the test files and then you can just copy them.
Sure, that is fine with me. No rush; if you come up with a pattern you like and just put it here, I could also do insert a header myself.
I've uploaded new versions of the tests that have minimal docs and attribution. These should be suitable for you to import into your project.
I did something else for you, too. Rather than hardcoding the namespaces, I put them in variables then used those everywhere. In many cases, you should be able to update the single hardcoded namespace and everywhere else in the same file picks it up.
When you commit these, you can use GIT_AUTHOR_NAME
and GIT_AUTHOR_EMAIL
(see the docs on env vars) so your repo credits the right people. There is also GIT_COMMITTER_*
, which would be you (or whomever). There's one test where I'm not the original author, so something like this might work:
env GIT_AUTHOR_NAME='Wim Lewis' GIT_AUTHOR_EMAIL='wiml@hhhh.org' t/write_binary.t
env GIT_AUTHOR_NAME='brian d foy' GIT_AUTHOR_EMAIL='brian.d.foy@gmail.com' t/*.t
For what it's worth, I'd import the files as-is, and then in a separate pull request do the modifications that you need. But, whatever works for you.
@briandfoy thanks so much! I expect to follow the path you expected.
For what it's worth, I'd import the files as-is, and then in a separate pull request do the modifications that you need. But, whatever works for you.
I ended up using a merge commit within kulp/Mac-PropertyList-SAX#5 to segregate the additions, so that my master
branch did not see tests popping out of and into existence, while still showing the imports as direct additions.
Thanks again for working with me on this.