Lint, style, CI, README improvements. #4
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@shurcooL is making me say "LGTM". |
|
|
||
| It uses the same mapping scheme as the Go Playground, and when a snippet isn't found locally, | ||
| it defers to fetching it from the Go Playground. This effectively augments our world of available | ||
| snippets with that the Go Playground. |
There was a problem hiding this comment.
Thanks for catching, fixed in 3f9e76b.
|
PTAL. |
|
LGTM, except that I would prefer to use CircleCI instead of Travis. GopherJS itself is already using CircleCI and it is also free for open source projects. |
|
Ok. We can discuss which CI system to use in the future. Let's start with Travis, since I already have a capable setup for it, and if we decide it's worth to switch to Circle, that can be another PR (where we can make sure all of the current functionality is preserved, etc.). |
Idiomatic Go style suggests using consistent case for acronyms. Source: https://github.com/golang/go/wiki/CodeReviewComments#initialisms. Resolves the following golint issues: $ golint . id.go:11:6: func snippetBodyToId should be snippetBodyToID id.go:25:6: func validateId should be validateID
I mistakenly used to think that Go style suggests always starting
package summary of commands with "Command {name} ...". That isn't true.
Go style only suggests that package summaries should start with
"Package {name} ..." for packages (not commands). Commands have no
restrictions on package summary phrasing. So, remove the "Command"
prefix since it's not helpful. Also remove trailing blank line in
package summary.
Update README to include the same package summary as in godoc.
Add Travis CI with build, diff, vet and tests.
Add badges for godoc and Travis CI to README. Also add installation
instructions. The README was updated in a tool-assisted manner via
gorepogen.
dmitshur
force-pushed
the
lint-style-CI-README-improvements
branch
from
3f9e76b to
c9420af
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please see individual commit messages (expanded versions) for full details.