| 1 | open this file with eclipse for best display. |
| 2 | |
| 3 | (some programs like notepad will display boxes instead of newlines) |
| 4 | |
| 5 | notes/danny.org and notes/cindy.org are files to help danny and cindy |
| 6 | keep "org"anized. they each have 3 secions in them. those sections are |
| 7 | "todo", "doing", and "done". each section contains bullet points for |
| 8 | each thing a dev should be keeping track of. here's an example name.org |
| 9 | file: |
| 10 | |
| 11 | ==== begin example name.org file ==== |
| 12 | |
| 13 | * todo |
| 14 | * make PID method that takes input from gyro and turns robot |
| 15 | * get input from gyro printing in riolog |
| 16 | * make method that turns robot in place based only on |
| 17 | difference term |
| 18 | * write skeleton for pneumatic piston to extend defense arm |
| 19 | * doing |
| 20 | * make PID method that takes input from gyro and turns robot |
| 21 | * get input from gyro printing in riolog |
| 22 | * done |
| 23 | * drive in a square using dead reckoning |
| 24 | |
| 25 | ==== end example name.org file ==== |
| 26 | |
| 27 | each bullet point without sub-points should be one commit. for example, |
| 28 | see commit 56c148bd962f3aadfc4595bb5473fa7d18e55b78. let's have a look |
| 29 | at it, then i'll point out some important points. |
| 30 | here's the diff from that commit: |
| 31 | |
| 32 | ==== begin diff 56c148bd ==== |
| 33 | ------------------------------- notes/cindy.org ------------------------------- |
| 34 | index 09b3585..00acb0c 100644 |
| 35 | @@ -1,16 +1,16 @@ |
| 36 | * todo |
| 37 | * figure out where the frame perimeter starts, and where the arm is mounted |
| 38 | relative to that |
| 39 | * find out actual arm and hand length, as well as the height at which the arm |
| 40 | is mounted |
| 41 | - * change method "getArmHorizontalDist" to "getArmHorizontalDisplacement" |
| 42 | * change method "getArmHeight" to "getArmVerticalDisplacement" |
| 43 | * for getArmHorizontalDisplacement figure out if measurements are all in |
| 44 | inches |
| 45 | * doing |
| 46 | - * change method "getArmHorizontalDist" to "getArmHorizontalDisplacement" |
| 47 | + * change method "getArmHeight" to "getArmVerticalDisplacement" |
| 48 | * done |
| 49 | * code review |
| 50 | * change arm and hand to "armHorizontal/armVertical" and "handHorizontal/ |
| 51 | handVertical" |
| 52 | + * change method "getArmHorizontalDist" to "getArmHorizontalDisplacement" |
| 53 | |
| 54 | -------- src/org/usfirst/frc/team3501/robot/subsystems/DefenseArm.java -------- |
| 55 | index 020d51b..401f09e 100755 |
| 56 | @@ -90,35 +90,35 @@ public class DefenseArm extends Subsystem { |
| 57 | * Math.cos(getHandPotAngle()); |
| 58 | return (armHorizontalDisplacement + handHorizontalDisplacement); |
| 59 | } |
| 60 | |
| 61 | - public double getArmHeight() { |
| 62 | + public double getArmVerticalDisplacement() { |
| 63 | double armMounted = Constants.DefenseArm.ARM_MOUNTED_HEIGHT; |
| 64 | double armVerticalDisplacement = Constants.DefenseArm.ARM_LENGTH |
| 65 | * Math.sin(getArmPotAngle()); |
| 66 | |
| 67 | ==== end diff 56c148bd ==== |
| 68 | |
| 69 | in this diff, cindy moved a few bullet points. they are |
| 70 | |
| 71 | * change method "getArmHorizontalDist" to "getArmHorizontalDisplacement" |
| 72 | |
| 73 | and |
| 74 | |
| 75 | * change method "getArmHeight" to "getArmVerticalDisplacement" |
| 76 | |
| 77 | the first bullet moved from "todo" to "doing" and the second moved |
| 78 | from "doing" to "done". the first one, that moved from "todo" to |
| 79 | "doing" is moved to the "doing" section because it describes what this |
| 80 | commit is doing. it may take several commits to complete a bullet |
| 81 | point. in that case, the bullet point would stay in the "doing" |
| 82 | section for all the commits. |
| 83 | |
| 84 | the second bullet moved from "doing" to "done" because it's done by |
| 85 | the time this commit is made. |
| 86 | |
| 87 | also included in commit 56c148bd is the code that implements the |
| 88 | bullet point. notice how small the commit is, and also how quickly it |
| 89 | was made. the 2 commits before and the one after happen over the |
| 90 | course of 3 minutes and 11 seconds. |