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.

Sign up for GitHub

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

Jump to bottom

Improve README, add contributing guide and license #16

Merged
merged 6 commits into from
Jan 22, 2021
Merged

Improve README, add contributing guide and license #16

merged 6 commits into from
Jan 22, 2021

Conversation

patrislav
Copy link
Contributor

This PR adds all the important information to the README, adds a new contributing guide in the CONTRIBUTING.md file, as well as the LICENSE file with MIT license.

Closes: #10

@patrislav patrislav self-assigned this Jan 18, 2021
@xescugc
Copy link
Member

xescugc commented Jan 19, 2021 

~/.../github.com/cycloidio/cost-estimation [master] $> golint ./...
aws/field/field.go:9:2: exported const SKU should have comment (or a comment on this block) or be unexported
aws/field/field.go:36:2: comment on exported const DatabaseEngine should be of the form "DatabaseEngine ..."
aws/terraform/db_instance.go:15:6: exported type DBInstance should have comment or be unexported
mysql/backend.go:27:1: exported method Backend.Product should have comment or be unexported
mysql/backend.go:28:1: exported method Backend.Price should have comment or be unexported
mysql/price.go:65:1: exported method PriceRepository.Filter should have comment or be unexported
mysql/price.go:93:1: exported method PriceRepository.Upsert should have comment or be unexported
mysql/price.go:122:1: exported method PriceRepository.DeleteByProductWithKeep should have comment or be unexported
mysql/product.go:64:1: exported method ProductRepository.Filter should have comment or be unexported
mysql/product.go:92:1: exported method ProductRepository.FindByVendorAndSKU should have comment or be unexported
mysql/product.go:103:1: exported method ProductRepository.Upsert should have comment or be unexported

I would also make it complient and potentially add some doc.go in packages to explain the purpose.

@patrislav
Copy link
Contributor Author

I would also make it complient and potentially add some doc.go in packages to explain the purpose.

Fixed golint (not checked automatically until #7). Which packages would benefit most from a doc.go?

@xescugc
Copy link
Member

xescugc commented Jan 19, 2021

It's more up to you :) I normally add it to every pkg (just because I like to have those docs formatted). But I would say it's needed on packages that have a general use so you explain what and why.

@patrislav
Copy link
Contributor Author

Added some documentation to most packages.

xescugc
xescugc approved these changes Jan 22, 2021
View reviewed changes
Copy link
Member

@xescugc xescugc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM you can RS if you want.

On OSS we are moving now to Squash directly on merge too :).

Once it's OSS remember to add the badge of godocs.

@patrislav patrislav merged commit 538580e into master Jan 22, 2021
@patrislav patrislav deleted the pk-documentation branch January 22, 2021 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xescugc xescugc xescugc approved these changes

Assignees

@patrislav patrislav

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add documentation for library consumers
2 participants
@patrislav @xescugc