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

Global Style Guide #2

Open
broad-well opened this issue Apr 11, 2018 · 2 comments
Open

Global Style Guide #2

broad-well opened this issue Apr 11, 2018 · 2 comments
Labels
standard Corresponds to the standards used throughout the project, such as documentation & design heuristics.

Comments

@broad-well
Copy link
Member

broad-well commented Apr 11, 2018

This issue is meant for discussion of choosing and customizing the global Style Guide that's utilized throughout. Note that once the standard style guide has been established, the project Code Style settings for Android Studio should always correspond to it.

What is a style guide?

A style guide standardizes the details of the code style of this project. Indentation, naming conventions, and syntax-based semantic expressions are among the topics dictated by the style guide.

@broad-well broad-well added the standard Corresponds to the standards used throughout the project, such as documentation & design heuristics. label Apr 11, 2018
@broad-well
Copy link
Member Author

Google's Java Style Guide seems like a good starting point.

@LakeYin
Copy link
Contributor

LakeYin commented Apr 11, 2018

Motors and servos should be designated by motor or servo. If the motor/servo is used for movement, letters following should designate the position. For example: motorFL designates a front left motor. The front/back positioning should come first before left right. For motors and servos not part of movement, the following should be the role of the motor/servo and possible position designation if there are more than one. For example: servoWinchR designates a winch servo on the right.

LakeYin added a commit that referenced this issue Oct 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
standard Corresponds to the standards used throughout the project, such as documentation & design heuristics.
Projects
None yet
Development

No branches or pull requests

2 participants