peterruggero / postmaster-go

GoLang bindings for the Postmaster API.
2 stars 4 forks source link

directory name does not match package name #7

Open insasho opened 10 years ago

insasho commented 10 years ago

I'm using the postmaster-go library in a project now and I've noticed the following practice from Effective Go (http://golang.org/doc/effective_go.html#package-names) is not being followed:

Another convention is that the package name is the base name of its source 
directory; the package in src/pkg/encoding/base64 is imported as "encoding/base64" 
but has name base64, not encoding_base64 and not encodingBase64.

Failure to respect this convention breaks syntax highlighting and automatic package imports in IntellIJ.

One possible solution is to create a subdirectory called "postmaster" and moving the contents there. This allows you to keep the postmaster-{{language}} pattern of package names that you seem to have under the postmaster user, while also respecting Go language conventions.

tmodrzynski commented 10 years ago

Thanks for your input - we have added it to our backlog and will take care of it as soon as we can!