Skip to content
This repository was archived by the owner on Oct 25, 2026. It is now read-only.
cml1010101 edited this page Jan 12, 2025 · 7 revisions

Welcome to the Reefscape wiki!

Please note that the purpose of the wiki is to lay out the rules and flow that Team 172 will follow throughout the 2024 offseason and 2025 season.

Any failure to comply with the rules of this wiki will result in a punishment worse than what the strategy team threatened last year. It will also have an ironic twist, but emphasis on the "worse" part.

Basic Git Rules

  1. All branch names must use one of five different types of character: a number, a letter, a '#', a '/', or a '-'. Absolutely no emojis in branch names. I can't believe I have to clarify this, Everett.

  2. All commit messages should be brief, but at least somewhat descriptive. Please follow instructions in this link.

  3. Please use merges instead of rebases. NOTE: this is a change from last year. Merges will allow for more simplicity in dealing with conflicts.

  4. One branch, one feature. Do not put multiple features in one branch except in very rare cases when granted permission.

  5. Branch names should be descriptive: "{issue number}-a-brief-feature-name"

Pull Requests, and General Repository Management

  1. There will be a main branch. All code will always work on the main branch.

  2. Only I, Connor Lund, will be able to approve pull requests into the main branch.

  3. That said, you are not inhibited from reviewing pull requests. In fact, I would encourage you to do so as it familiarizes oneself with the code in the repository.

  4. There will be a devel branch. This branch will allow programmers to merge multiple features into a single branch to test for compatibility issues, etc. NOTE: this is not safe code, nor is it production ready. It is however, the step towards production-level code.

  5. All branches merged into main MUST pass all status checks. This includes build AND formatting checks.

  6. All pull requests for main MUST indicated if they have been tested. They must be tested on the robot OR via simulation if impossible to test on the robot.

Coding Conventions

  1. All curly braces will be on their own lines. This increases the clarity of the code. I also like it better.

  2. All lines will be 120 characters at maximum. I don't like scrolling side to side.

  3. All methods will have Javadocs before them describing the purpose of the function, how it works, and the preconditions for the inputs.

  4. All large (4ish lines) blocks of codes must have comments describing what is going on. When in doubt, comment.

  5. All tabs will be 4 spaces wide. No exceptions.

  6. All field members will be protected and final. Only in rare cases, exceptions on the final can be made. Getters and setters will be used to modify as needed, so field members must be protected.

  7. All methods will be either protected if used internally, or public if intended to be used by other classes.

  8. Interfaces are preferred. When possible, please use interfaces to define common functionality if there are multiple implementations of common functionality, or could potentially be multiple implementations.

  9. Use AdvantageKit for logging. More specifics are to be developed later.

Discussions and Process

To promote coordination among programmers, to ensure the awareness of intentions, and to prevent programmers from doing the same thing twice, we will be instituting the following:

  1. Every few days during the offseason, programmers will be expected to note what they are working on via GitHub discussions, and read each others' posts to understand what is going and what everyone is doing. During the season, this is expected every work day (hopefully not Sundays).

  2. Every time programmers meet, we will begin with a verbal discussion and summary of our projects and what we're working on.

  3. Programmers will use a Kanban strategy for their workflow.

  4. Issues and Ideas will be added to a back log.

  5. I will refine and split up issues as needed and put them into the To-Do. Issues will have qualifiers to describe how issues work.

  6. Programmers will contact me to request the assignment of specific issues.

  7. Programmers are then responsible for moving those issue into in progress, and in review as need be.