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

Add formatting guidelines to CONTRIBUTING.md #205

Merged
merged 2 commits into from
May 16, 2018
Merged

Add formatting guidelines to CONTRIBUTING.md #205

merged 2 commits into from
May 16, 2018

Conversation

enocom
Copy link
Contributor

@enocom enocom commented May 15, 2018

Fixes #97

@enocom enocom requested a review from markmandel May 15, 2018 22:55
markmandel
markmandel reviewed May 15, 2018
View reviewed changes
Copy link
Member

@markmandel markmandel left a comment

Choose a reason for hiding this comment

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

Super minor nit below. Happy for you to ignore if you want.

Curious question - #97 does mention a .editorconfig but we don't have an .editorconfig , even though this is closing that ticket.

Should we have a .editorconfig?

CONTRIBUTING.md Outdated

When submitting pull requests, make sure to do the following:

- Format all Go code with [gofmt](https://golang.org/cmd/gofmt/).
Copy link
Member

Choose a reason for hiding this comment

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

gofmt and/or goimport ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm. Technically gofmt, but you'd be mad to write your own import statements and not use goimports.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about another sentence after this one that says, "Many people use goimports which adds import statements automatically while also running gofmt"?

Copy link
Member

Choose a reason for hiding this comment

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

SGTM.

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 322ba06c-6532-4b0d-afd7-d0f5ff1052e4

The following development artifacts have been built, and will exist for the next 30 days:

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: fc3df6b8-01a2-4d7d-91a4-ae28b035e05f

The following development artifacts have been built, and will exist for the next 30 days:

@markmandel
Copy link
Member

Content LGTM - I'll repeat my earlier question, I think it got missed:

Curious question - #97 does mention a .editorconfig but we don't have an .editorconfig , even though this is closing that ticket.

Should we have a .editorconfig?

@enocom
Copy link
Contributor Author

enocom commented May 16, 2018

@markmandel Since opening the issue, I have realized gofmt does what .editorconfig hopes to do. So, I think we're good without it.

@markmandel markmandel merged commit 43d9e07 into googleforgames:master May 16, 2018
@enocom enocom deleted the add-formatting-guidelines branch May 16, 2018 16:52
@markmandel markmandel added this to the 0.2 milestone May 19, 2018
@markmandel markmandel mentioned this pull request May 22, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@markmandel markmandel markmandel approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.2.0
Development

Successfully merging this pull request may close these issues.
3 participants
@enocom @agones-bot @markmandel