clarete / hackernews.el

Hacker News client for Emacs
GNU General Public License v3.0
248 stars 26 forks source link

Update Author and Maintainer headers #49

Closed basil-conto closed 6 years ago

basil-conto commented 6 years ago

Re: #31.

Do you think this change makes sense @clarete? Here are the relevant header descriptions from (elisp) Library Headers:

‘Author’
     This line states the name and email address of at least the
     principal author of the library.  If there are multiple authors,
     list them on continuation lines led by ‘;;’ and a tab or at least
     two spaces.  We recommend including a contact email address, of the
     form ‘<...>’.  For example:

          ;; Author: Your Name <yourname@example.com>
          ;;      Someone Else <someone@example.com>
          ;;      Another Person <another@example.com>

‘Maintainer’
     This header has the same format as the Author header.  It lists the
     person(s) who currently maintain(s) the file (respond to bug
     reports, etc.).

     If there is no maintainer line, the person(s) in the Author field
     is/are presumed to be the maintainers.  Some files in Emacs use
     ‘FSF’ for the maintainer.  This means that the original author is
     no longer responsible for the file, and that it is maintained as
     part of Emacs.
clarete commented 6 years ago

Hi @basil-conto, they make total sense! Also, I'd add your name to the copyright list within the years you've been working on the project! Thanks a lot for such great contributions, I really learned a ton since you started contributing with the project!!

basil-conto commented 6 years ago

Thanks @clarete!

I'd add your name to the copyright list within the years you've been working on the project

I'm not against this, but FYI I'm not particularly keen on being attributed or holding copyright. I'm also not particularly familiar with what is legally required.

So, would you prefer if I added my name to the copyright list even though I'm not requesting it? Would you be interested in following the advice here: https://opensource.google.com/docs/releasing/authors/ instead, by having something like Copyright [Years] The [Project Name] Authors?

basil-conto commented 6 years ago

I really learned a ton since you started contributing with the project!

I'm glad, because I have, too. :)

clarete commented 6 years ago

I unsuccessfully tried to find a piece of text from the Gnu project that addresses this sort of decision. As far as I remember, copyright can be attributed to an author after they contribute with a "Relevant amount" of code. Although that's pretty subjective, I think your contributions surpassed that mark a while ago, in importance and code length. I'm pretty happy with your solution! I just really wanted to make sure that your contributions were acknowledged in the most comprehensible way!

basil-conto commented 6 years ago

I'm pretty happy with your solution!

The only thing I'm not sure about with Google's advice is what this project's name should be. "Hackernews.el"? "Hackernews.el Emacs Client"? Any ideas?

I just really wanted to make sure that your contributions were acknowledged in the most comprehensible way!

Thanks! That my patches were merged and useful even for a couple of other people is more than enough acknowledgement for me, though. :)

clarete commented 6 years ago

The only thing I'm not sure about with Google's advice is what this project's name should be. "Hackernews.el"? "Hackernews.el Emacs Client"? Any ideas?

Hmmm, that's a good question. I feel like "Hackernews.el" would be enough for Emacs users hehe.

Thanks! That my patches were merged and useful even for a couple of other people is more than enough acknowledgement for me, though. :)

Sure! Whatever works for you! I really like following the GNU standards when it comes to this sort of thing, that's why I really liked your suggestion about the AUTHORS file too! \o/ \o/ \o/

basil-conto commented 6 years ago

I feel like "Hackernews.el" would be enough for Emacs users

Same, I just hope it doesn't count as trademark infringement or similar.