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

Add a STYLE_GUIDE.md #2

Closed
hyena opened this issue Feb 24, 2019 · 0 comments
Closed

Add a STYLE_GUIDE.md #2

hyena opened this issue Feb 24, 2019 · 0 comments
Assignees

Comments

@hyena
Copy link
Collaborator

hyena commented Feb 24, 2019

It should go in the project top level. May just point to another existing style guide with caveats/deltas e.g. https://google.github.io/styleguide/cppguide.html

If covering C++ style in terms of coding style is premature, a guide covering just code formatting is a fine start for this. Getting something in place where we can document decisions later as we make them is more important than answering every side case now. See https://github.com/Weasyl/weasyl/blob/master/STYLE_GUIDE.md for an example of a simple one I wrote for Weasyl.

Once done, add a new issue about finding a linter (e.g. http://clang.llvm.org/extra/clang-tidy/ looks promising but it may be a poor match for the project's infrastructure)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants