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

[doc] Style guide for library and application written in Go #103

Open
1 of 3 tasks
at15 opened this issue Dec 21, 2018 · 1 comment
Open
1 of 3 tasks

[doc] Style guide for library and application written in Go #103

at15 opened this issue Dec 21, 2018 · 1 comment
Assignees
Milestone

Comments

@at15
Copy link
Member

at15 commented Dec 21, 2018

Since we are having more contributors (@xplorld, it's better to come up with a strict standard of how to develop and use Go library within dyweb), this would also reduce the cost for code review (if any). In the future we can even enforce those style using static analysis #75

For now, it's just my style based on current gommon code and stuff I read from blog.

It will have three parts

  • general, applies all types of Go project, library (like gommon, go.ice), application (like Ayi)
  • library, have more restriction since it will be imported by many applications
  • application, how to organize code by 'business logic', though most 'business' we have in dyweb are command line util and 'cloud native' instead of shopping cart ....
@at15 at15 added this to the 0.0.9 milestone Dec 21, 2018
@at15 at15 self-assigned this Dec 21, 2018
@at15
Copy link
Member Author

at15 commented Dec 21, 2018

@gaocegege I will put the draft in #96 because error handling is also important part of style and I can take the chance of writing the style guide to revisit existing code in gommon

@at15 at15 mentioned this issue Dec 31, 2018
4 tasks
@at15 at15 modified the milestones: 0.0.9, 0.0.10 Dec 31, 2018
@at15 at15 modified the milestones: 0.0.10, 0.0.12 Apr 13, 2019
@at15 at15 modified the milestones: 0.0.13, future Jan 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant