Given below are the standards and conventions to follow in this course.
When something is not covered by the given standard/convention, you are free to choose which style you want to follow for that, but try to be consistent with the existing code (if any), and ensure everyone in the team follows the same (if it is a team project).
Java
- REQUIRED Follow the basic and intermediate rules in the SE-EDU Java coding standard.
- OPTIONAL Follow advanced rules.
Git
- REQUIRED Follow the Git commit message subject conventions in the SE-EDU Git conventions.
- CONDITIONAL Writing a commit message body is optional, but if you do write one, follow at least basic conventions for the commit message body.
Markdown
- OPTIONAL Follow Markdown style guide at SE-EDU.
Documentation
- OPTIONAL Follow Google developer documentation style guide.