Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revel Code Styleguide #752

Closed
brendensoares opened this issue Oct 7, 2014 · 10 comments
Closed

Revel Code Styleguide #752

brendensoares opened this issue Oct 7, 2014 · 10 comments
Labels
status-planning Active planning underway topic-docs
Milestone

Comments

@brendensoares
Copy link
Member

Seems clear that given so many contributors, we need to enforce a more consistent coding style.

One example is import grouping by Go runtime packages and 3rd party in alphabetical order (reference).

@brendensoares brendensoares added enhancement status-planning Active planning underway labels Oct 7, 2014
@brendensoares brendensoares added this to the v0.12 milestone Oct 7, 2014
@notzippy
Copy link
Collaborator

notzippy commented Oct 7, 2014

Since we are splitting up the revel commands, samples and modules we should also add a gerrit server to the mix. So we can make changes that affect multiple repositories in one sweep. Also makes code review and approval easier..

@ghost
Copy link

ghost commented Oct 7, 2014

go fmt has been a requirement for a long of time (BTW it automagically sorts imports in alphabetical order). Can we make go lint a one more requirement, so most style mistakes are fixed as well?

@brendensoares
Copy link
Member Author

@notzippy Gerrit doesn't look like it adds anything that github already offers. Please explain how it would benefit us.

@AnonX that sounds like a good idea to experiment with.

@notzippy
Copy link
Collaborator

notzippy commented Oct 7, 2014

@brendensoares It would be a long discussion comparing gerrit patchsets and github PRs (I just put it out there as gerrit IMHO does a better job of developing an improvement). FYI http://gerrithub.io links directly to github, personally I have not used gerrithub (once again just spewing out random thoughts).

@brendensoares
Copy link
Member Author

@notzippy nice that it doesn't require us to self host it. It's definitely something to look at in the future (after we make some decent progress on the current roadmap).

@pushrax
Copy link
Contributor

pushrax commented Oct 8, 2014

@AnonX the bit about sorting imports was actually about leaving blank lines between groups of packages. Check out the link.

IMO just following all of https://code.google.com/p/go-wiki/wiki/CodeReviewComments would get us 90% of the way there.

@ghost
Copy link

ghost commented Oct 8, 2014

the bit about sorting imports was actually about leaving blank lines between groups of packages. Check out the link.

@pushrax I know. This issue is likely partially inspired by the latest comments in discussion #606.

@brendensoares brendensoares modified the milestones: v0.15, v0.12 Jan 7, 2015
@ghost
Copy link

ghost commented Mar 9, 2015

Interesting link: http://goreportcard.com

@brendensoares
Copy link
Member Author

@AnonX sweet tool! Revel got a B. Room for improvement :)

@jeevatkm jeevatkm modified the milestones: v0.15, Backlog Jul 1, 2016
@notzippy
Copy link
Collaborator

Added badge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status-planning Active planning underway topic-docs
Projects
None yet
Development

No branches or pull requests

5 participants