docs(branch-protection): add TODO comments pointing refactor opportun…

…ities

Signed-off-by: Diogo Teles Sant'Anna <[email protected]>

checks/evaluation/branch_protection_test.go

@@ -35,6 +35,7 @@ func testScore(branch *clients.BranchRef, codeownersFiles []string, dl checker.D
 	return computeFinalScore([]levelScore{score}, dl)
 }
 
+// TODO: order of tests to have progressive scores.
 func TestIsBranchProtected(t *testing.T) {
 	t.Parallel()
 	trueVal := true
@@ -49,6 +50,7 @@ func TestIsBranchProtected(t *testing.T) {
 		expected        scut.TestReturn
 	}{
 		{
+			// TODO: Naming is inconsistent. We should change this to make it score 0.
 			name: "Nothing is enabled",
 			expected: scut.TestReturn{
 				Error:         nil,

clients/githubrepo/branches.go

@@ -323,6 +323,7 @@ func (handler *branchesHandler) getBranch(branch string) (*clients.BranchRef, er
 	return branchRef, nil
 }
 
+// TODO: Move these two functions to below the GetBranchRefFrom functions, the single place they're used.
 func copyAdminSettings(src *branchProtectionRule, dst *clients.BranchProtectionRule) {
 	copyBoolPtr(src.IsAdminEnforced, &dst.EnforceAdmins)
 	copyBoolPtr(src.RequireLastPushApproval, &dst.RequireLastPushApproval)