Closed chrismytton closed 8 years ago
Slightly more in line with our existing naming (there's no consistent policy, which is fine), probably better to say what it is rather than what it does:
data_pr_change_summarizer
pr
isn't great in there, but on the other hand, it's not that obscure in the context of what it's doing. Take it out and the repo is making grander claims than it executes; expand it to pull_request
(or even pull-request
) and the repo name has become Llanfairpwllgwyngyllgogerychwyrndrobwyllllantysiliogogogoch.
Ending with ize
is fine and, because of the tendency of tech keywords to adopt US spelling (hello color
), it's something English-speaking nerds simply have to get used to. Embrace ize
. Like we did in the 15th century already.
Do we have a preference on hyphens vs. underscores in repo names? I think it's because you're adhering to useful behaviour for Gems for the underscores, but I notice it's otherwise hyphens on the key repos I'd called out in https://github.com/everypolitician/everypolitician's README.
I don't think we've got an explicit preference (yet) but I tend to try and stick to the guidelines for gem naming. They basically say use underscores unless it's an extension to another library (e.g. jekyll-everypolitician
).
So I would say that viewer-sinatra
and webhook-manager
are probably not such great names, but everypolitician-popolo
and jekyll-everypolitician
are OK because they sit under the everypolitician
and jekyll
namespaces.
Done!
After a conversation in Slack earlier it was suggested that we should rename this repository as it can be tricky to find.