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

Integrate a spell and/or grammar check into build system #187

Closed
markmandel opened this issue Apr 27, 2018 · 5 comments
Closed

Integrate a spell and/or grammar check into build system #187

markmandel opened this issue Apr 27, 2018 · 5 comments
Labels
area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. good first issue These are great first issues. If you are looking for a place to start, start here! help wanted We would love help on these issues. Please come help us! kind/documentation Documentation for Agones
Milestone

Comments

@markmandel
Copy link
Member

markmandel commented Apr 27, 2018

It's super easy to miss misspelled words in our .md documentation files.

It would be great if there was a spellchecker (and maybe even a grammar / documentation helper?) integrated into the build system to ensure the documentation continues to be written well.

We could probably just install aspell and call it directly.

Or maybe something like write-good - but I don't know if we want to add node to our build images. Maybe there is a go version somewhere? Or an online service? Possibly worth exploring.

@markmandel markmandel added help wanted We would love help on these issues. Please come help us! good first issue These are great first issues. If you are looking for a place to start, start here! kind/documentation Documentation for Agones area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. labels Apr 27, 2018
@markmandel
Copy link
Member Author

There is this docker image, that seems to get updated regularly.
https://hub.docker.com/r/hochzehn/write-good/
Could possibly be integrated into cloud builder and/or used as a make target.

@cyriltovena
Copy link
Collaborator

Started to use locally https://github.com/golangci/golangci-lint which advertise faster (also a lot less memory usage) than gometalinter, looks good so far.

They have an optional spellchecker (https://github.com/client9/misspell).

We could do a two birds one stone here ? Improve lint target and have grammar check.

@markmandel Can you have a look at https://github.com/golangci/golangci-lint and let me know what do you think ?

@markmandel
Copy link
Member Author

I think we looked at this a while back as well - for the same reasons. @enocom do you have any thoughts or feelings?

Need to make sure our exclude list still works. I'd also like to add goimport testing too.

@enocom
Copy link
Contributor

enocom commented Sep 6, 2018

It would be nice to use misspell, especially if we're going to switch to golangci-lint.

@markmandel
Copy link
Member Author

I say -- let's do it!

Also linking #237 to this, as it looks like the work crosses between the tickets.

@markmandel markmandel added this to the 0.5.0 milestone Feb 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. good first issue These are great first issues. If you are looking for a place to start, start here! help wanted We would love help on these issues. Please come help us! kind/documentation Documentation for Agones
Projects
None yet
Development

No branches or pull requests

3 participants