github repos
Nate Finch
nate.finch at canonical.com
Thu Mar 6 12:38:40 UTC 2014
Now that things are being created in github, there are some conventions
that we should follow. This is easiest to do by creating all repos from
the github UI and cloning them to your local machine.
Repos must have a README.md file, this is the documentation that is
displayed on the repo homepage.
Repos should have a LICENSE file, which holds the license for the code.
When creating the repo, github gives you a choice from a long list of
standard licenses... I'm not sure what one we should be choosing, perhaps
other people can suggest the proper license to use?
Repos should have a .gitignore... again, github gives you a list to choose
from, based on language, so most of the time we'll be choosing Go there.
Put the code directly under the repo root... don't put it in a subdirectory
unless you really need to.
New packages that could be of use to other people should be in their own
repo under github.com/juju.
note that from $GOPATH/src/github.com/juju you can do
$ go get -u ./...
to update all the packages under github.com/juju (and everything they
depend on), which makes having multiple repos not really a problem.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/juju-dev/attachments/20140306/4e6d9938/attachment.html>
More information about the Juju-dev
mailing list