-
Notifications
You must be signed in to change notification settings - Fork 4
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 brief style guidelines. #5
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. I would like to note that whispers of C++20 have reached even into the Contribution.md file. Perhaps something to revisit in the future.
I think it would also be a good idea to set a (soft) column limit of 120 characters. |
8eafdd4
to
7eed8e5
Compare
Add guidelines on line breaks.
Some details that I think should be added for clarification. Initializing classes with the Structures localized as parameter inputs. When there are a lot of parameters it becomes a lot more manageable to use structures to handle them. Perhaps add some details on this? These points come from details in the Also with regards to file names and classes. Perhaps state that files with only one class names must match the name of their file (or something similar). Otherwise looks good to me. |
I concur with @reid-g's points |
This is important issue but somewhat out of scope of this PR. @reid-g would you mind creating a separate GitHub issue with details and examples? |
This should probably be merged to
develop
, but for opportunistic convenience, I suggest we merge it here. Since #1 will likely prompt discussion on new style guidelines, let's direct this PR tocomposer-dev
branch.