Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 2.83 KB

README.md

File metadata and controls

91 lines (61 loc) · 2.83 KB

Amazon Cloud Drive client for Go

Build Status GoDoc

Amazon Cloud Drive uses oAuth 2.0 for authentication. The token server takes care of the oAuth authentication. For your convenience, an instance of the server is deployed at:

https://go-acd.appspot.com

Install

This project is go-gettable:

go get gopkg.in/acd.v0/...

Usage

In order to use this library, you must authenticate through the token server.

CLI

Run acd help for usage.

Library

Consult the Godoc for information on how to use the library.

Contributions

Contributions are welcome as pull requests.

Commit Style Guideline

We follow a rough convention for commit messages borrowed from Deis who borrowed theirs from CoreOS, who borrowed theirs from AngularJS. This is an example of a commit:

feat(token): remove dependency on file system.

use an IO.Reader and IO.Writer to deal with the token.

To make it more formal, it looks something like this: {type}({scope}): {subject} {body} {footer}

The {scope} can be anything specifying place of the commit change.

The {subject} needs to use imperative, present tense: “change”, not “changed” nor “changes”. The first letter should not be capitalized, and there is no dot (.) at the end.

Just like the {subject}, the message {body} needs to be in the present tense, and includes the motivation for the change, as well as a contrast with the previous behavior. The first letter in a paragraph must be capitalized.

All breaking changes need to be mentioned in the {footer} with the description of the change, the justification behind the change and any migration notes required.

Any line of the commit message cannot be longer than 72 characters, with the subject line limited to 50 characters. This allows the message to be easier to read on github as well as in various git tools.

The allowed {types} are as follows:

feat -> feature
fix -> bug fix
docs -> documentation
style -> formatting
ref -> refactoring code
test -> adding missing tests
chore -> maintenance

Credits

Although this project was built from scratch, it was inspired by the following:

License License

The MIT License (MIT) - see LICENSE for more details