Skip to content

Latest commit

 

History

History
63 lines (61 loc) · 2.38 KB

Standards.md

File metadata and controls

63 lines (61 loc) · 2.38 KB
Raw

Naming Standards

  • camelCase
    • Methods
    • Variables
  • BumpyCase/PascalCase
    • Classes
  • CAPS_LOCK
    • Static Variables
    • Enumeration Values
  • lowercase
    • Folder Names

Recurring Structure

* [Competition Name]-[year]
	- src
		- org
			- usfirst
				- frc
					- team3695
						- robot
							- commands
							- enumeration
							- subsystems
							- util
							- Constants.java
							- Controller.java
							- OI.java
							- Robot.java
						- util
							- Tomes of Knowledge
								- Standards.md
								- Competition.md
								- Concept.md
							- layout.smart.xml
	- README.md

Code Formalities

  • Use tabs to offset, not spaces
  • Add documentation for as much as possible
    • put /** javadoc */ descriptions above each method and class
    • use /// single line comments (three slashes) above variables or small code chunks that need to be documented
    • use // single line comments to comment out single lines of code
    • use // single line comments for, well, single line comments (notes and stuff)
    • use /** multi-line comments **/ to comment out blocks of code
    • use /** multi-line comments **/ for datatables (mainly for Constants use)

Github Formalities

  • ONLY PUSH TO YOUR OWN FORK, ALWAYS USE A PULL REQUEST TO APPLY CHANGES TO THE MASTER REPO
  • Always pull to the develop branch (admin handles master branch)
  • Commit often, pull seldom
  • The milestone assigned to an issue should be the latest acceptable version only
    • If it is completed before then, just add it to the changelog for the soonest version after its completion, but DO NOT retroactively change the milestone for the issue. Leave it be.
  • Always pull new code from the master fork to your fork before pulling code on your fork to the master fork
  • Commit messages should be Initial cased and end with a period
    • EX: Added this thing.
    • EX: Destroyed everything.
    • EX: Changed this. Blame Kurt. (second sentences are acceptable if they explain something necessary, but are not preferred)
  • Pull messages should be Initial cased and end with a period
    • Pull messages can have multiple sentences since they have multiple commits
    • EX: Broke literally everything.
    • EX: Fixed autonomous? (question marks are okay if you aren't sure about it yet)
    • EX: Added GRIP code. Worked on vision.