search

Brown-County-FIRST-Robotics / 1716-2023-robot

2023 Robot
Apache License 2.0
0 stars 0 forks source link

Change name of "test" folder #24

Open Mockapapella opened 1 year ago

Mockapapella commented 1 year ago

Normally in software projects, the "test(s)" folder is where all your Unit Tests are, not experimental code. "Unit Tests" are functions that assert various states about your code. If you have code that activates a motor when you press a button, it's good to have a separate piece of code that verifies that functionality. If the behavior of that function is modified in the future, say by changing what button needs to be pressed to activate the motor, the test will catch that and will fail as a result. This can be used in combination with git hooks to prevent code from being committed to a branch unless all tests pass.

I would suggest "experimental" or "sandbox" for the folder names. More information here: https://docs.wpilib.org/en/stable/docs/software/wpilib-tools/robot-simulation/unit-testing.html

cfinn68916 commented 1 year ago

I suggest that we split it into "experiments" and "archive". "Experiments" would be for stuff like the led test code. "Archive" would be for stuff that should have never been in tests, like DEATH STARE(++) and nt-drive.