From 417054a3a71891ac5ff4a0e444f16e19ae1985fd Mon Sep 17 00:00:00 2001 From: amsam0 <44983869+amsam0@users.noreply.github.com> Date: Tue, 4 Aug 2026 19:48:25 -0700 Subject: [PATCH 1/7] Update git-usage.mdx --- src/content/docs/best-practices/git-usage.mdx | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/src/content/docs/best-practices/git-usage.mdx b/src/content/docs/best-practices/git-usage.mdx index ccb17e53..2db33da0 100644 --- a/src/content/docs/best-practices/git-usage.mdx +++ b/src/content/docs/best-practices/git-usage.mdx @@ -9,8 +9,9 @@ A commit is a saved state of your repository. You should make a commit every time you complete a task (e.g. `Add per-path auto choosers`, `Fix joystick inputs inversion`, `Tune chassis heading PID gains`). This helps keep track of when new code is added. When you add changes through smaller, focused commits, you can isolate when a bug is introduced and easily roll back to a working state + Writing descriptive commit messages make it easy to see exactly what changed. -While diffs can only show what changed in code, commit messages can also communicate the context about a change and explain the why. +Avoid focusing on how you made the change (that's what the diff is for); instead, highlight the what and why. By convention, commit messages are concise, begin with a capital letter, don't use punctuation, and are in the imperative mood. Compare the following examples of good vs bad commit messages: @@ -28,9 +29,6 @@ Commit early and commit often. -For advanced users, the command line offers more capabilities. -[GitHub Desktop](https://docs.github.com/en/desktop/managing-commits) presents a simpler way to manage commits, using checkboxes to select files to commit, a text box for commit messages, and a button to create a commit. - ## Branches The `main` branch is where the working, tested version of the code lives during the build season. @@ -56,6 +54,16 @@ It is a good practice to push to your branch frequently to back up your work in Creating a new repository for different major projects or new seasons is a helpful way to keep track of projects. Repositories should have names that represent the purpose of its code, like "2026-rebuilt", "2026-kitbot", and "2026-offseason-turret". +## Clients + +A Git client provides an interface for interacting with a Git repository. + +For new Git users, [GitHub Desktop](https://docs.github.com/en/desktop) is recommended because it presents a simple, graphical way to manage a Git repository. Creating a commit is as easy as selecting files, writing the message in a text box, and clicking a button. + +[lazygit](https://github.com/jesseduffield/lazygit) is an intermediate option that retains much of the power of Git's CLI while being intuitive to use. + +Git's command line interface (CLI) is the most raw and powerful Git client. However, it may be difficult to learn. + ## Additional Information An in-depth tutorial can be found at the official [git website](https://git-scm.com/docs/gittutorial). From 3559c6ae6d658bed388bddc9319f261432d9d3f8 Mon Sep 17 00:00:00 2001 From: amsam0 <44983869+amsam0@users.noreply.github.com> Date: Tue, 4 Aug 2026 19:57:29 -0700 Subject: [PATCH 2/7] Update git-usage.mdx --- src/content/docs/best-practices/git-usage.mdx | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/src/content/docs/best-practices/git-usage.mdx b/src/content/docs/best-practices/git-usage.mdx index 2db33da0..b1555e93 100644 --- a/src/content/docs/best-practices/git-usage.mdx +++ b/src/content/docs/best-practices/git-usage.mdx @@ -60,20 +60,14 @@ A Git client provides an interface for interacting with a Git repository. For new Git users, [GitHub Desktop](https://docs.github.com/en/desktop) is recommended because it presents a simple, graphical way to manage a Git repository. Creating a commit is as easy as selecting files, writing the message in a text box, and clicking a button. +[Source control in VSCode](https://code.visualstudio.com/docs/sourcecontrol/overview) also offers a simple interface for Git. + [lazygit](https://github.com/jesseduffield/lazygit) is an intermediate option that retains much of the power of Git's CLI while being intuitive to use. Git's command line interface (CLI) is the most raw and powerful Git client. However, it may be difficult to learn. -## Additional Information - -An in-depth tutorial can be found at the official [git website](https://git-scm.com/docs/gittutorial). - -A guide for correcting common mistakes can be found at the [git flight rules repository](https://github.com/k88hudson/git-flight-rules/blob/master/README.md). +## Additional Resources -[GitHub Desktop](https://docs.github.com/en/desktop) is an alternative to command line or web browser interactions with GitHub. -With GitHub Desktop, you can perform Git commands through a graphical user interface. -It's a good resource for teams who are new to programming and may not have a lot of Git support or experience on the team, especially rookie teams. -While GitHub Desktop offers it's own simplified ways of using Git and GitHub, the information mentioned in this section can still apply. +An in-depth tutorial can be found at the official [Git website](https://git-scm.com/docs/gittutorial). -[Source control in VS Code](https://code.visualstudio.com/docs/sourcecontrol/overview) also offers a GUI for integrated source code management. -It lets you run Git commands from the command palette. +A guide for correcting common mistakes can be found at the [Git flight rules repository](https://github.com/k88hudson/git-flight-rules/blob/master/README.md). From 1edfc39e2aa2f980a25709b628bd5541fd050e56 Mon Sep 17 00:00:00 2001 From: amsam0 <44983869+amsam0@users.noreply.github.com> Date: Tue, 4 Aug 2026 20:23:24 -0700 Subject: [PATCH 3/7] Update git-usage.mdx --- src/content/docs/best-practices/git-usage.mdx | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/src/content/docs/best-practices/git-usage.mdx b/src/content/docs/best-practices/git-usage.mdx index b1555e93..b48481e8 100644 --- a/src/content/docs/best-practices/git-usage.mdx +++ b/src/content/docs/best-practices/git-usage.mdx @@ -8,7 +8,7 @@ description: Best practices for Git A commit is a saved state of your repository. You should make a commit every time you complete a task (e.g. `Add per-path auto choosers`, `Fix joystick inputs inversion`, `Tune chassis heading PID gains`). This helps keep track of when new code is added. -When you add changes through smaller, focused commits, you can isolate when a bug is introduced and easily roll back to a working state +When you add changes through smaller, focused commits, you can isolate when a bug is introduced and easily roll back to a working state. See [this article](https://www.freshconsulting.com/insights/blog/atomic-commits/) on atomic commits for more information. Writing descriptive commit messages make it easy to see exactly what changed. Avoid focusing on how you made the change (that's what the diff is for); instead, highlight the what and why. @@ -24,11 +24,6 @@ Compare the following examples of good vs bad commit messages: See this specification on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to learn about standardized conventions for writing commit messages. - - ## Branches The `main` branch is where the working, tested version of the code lives during the build season. From 691db62b2e3a1405d8a7aa3c1faa7c75f5d20a8c Mon Sep 17 00:00:00 2001 From: amsam0 <44983869+amsam0@users.noreply.github.com> Date: Tue, 4 Aug 2026 20:29:53 -0700 Subject: [PATCH 4/7] Update git-usage.mdx --- src/content/docs/best-practices/git-usage.mdx | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/content/docs/best-practices/git-usage.mdx b/src/content/docs/best-practices/git-usage.mdx index b48481e8..e19221e2 100644 --- a/src/content/docs/best-practices/git-usage.mdx +++ b/src/content/docs/best-practices/git-usage.mdx @@ -11,8 +11,9 @@ This helps keep track of when new code is added. When you add changes through smaller, focused commits, you can isolate when a bug is introduced and easily roll back to a working state. See [this article](https://www.freshconsulting.com/insights/blog/atomic-commits/) on atomic commits for more information. Writing descriptive commit messages make it easy to see exactly what changed. -Avoid focusing on how you made the change (that's what the diff is for); instead, highlight the what and why. +Avoid focusing on how you made the change (that's what the diff is for). Instead, highlight the what and why. By convention, commit messages are concise, begin with a capital letter, don't use punctuation, and are in the imperative mood. +If you want to include more information in a commit message, consider using the commit body. Compare the following examples of good vs bad commit messages: @@ -22,7 +23,8 @@ Compare the following examples of good vs bad commit messages: | Use the imperative mood: "Refactor swerve drive logic" | Are past tense, lowercase, or punctuated: "refactored swerve drive logic." | | Specific and provide context: "Fix swerve drive limiter bug for reliable drive control" | Are vague: "Fix bug" or "WIP" | -See this specification on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to learn about standardized conventions for writing commit messages. +For more on writing good commit messages, see [this article](https://cbea.ms/git-commit/). +Standardized specifications such as [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) are also good ways to keep commit messages organized. ## Branches @@ -57,9 +59,9 @@ For new Git users, [GitHub Desktop](https://docs.github.com/en/desktop) is recom [Source control in VSCode](https://code.visualstudio.com/docs/sourcecontrol/overview) also offers a simple interface for Git. -[lazygit](https://github.com/jesseduffield/lazygit) is an intermediate option that retains much of the power of Git's CLI while being intuitive to use. +[lazygit](https://github.com/jesseduffield/lazygit) is an intermediate option that retains much of the power of Git's command-line interface while being intuitive to use. -Git's command line interface (CLI) is the most raw and powerful Git client. However, it may be difficult to learn. +Git's command-line interface is the most raw and powerful Git client. However, it may be difficult to learn. ## Additional Resources From 08d7a2aa4fac6ee10da0e12898dba0f5436e9953 Mon Sep 17 00:00:00 2001 From: amsam0 <44983869+amsam0@users.noreply.github.com> Date: Tue, 4 Aug 2026 20:31:45 -0700 Subject: [PATCH 5/7] Update git-usage.mdx --- src/content/docs/best-practices/git-usage.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/best-practices/git-usage.mdx b/src/content/docs/best-practices/git-usage.mdx index e19221e2..c825eb4f 100644 --- a/src/content/docs/best-practices/git-usage.mdx +++ b/src/content/docs/best-practices/git-usage.mdx @@ -55,7 +55,7 @@ Repositories should have names that represent the purpose of its code, like "202 A Git client provides an interface for interacting with a Git repository. -For new Git users, [GitHub Desktop](https://docs.github.com/en/desktop) is recommended because it presents a simple, graphical way to manage a Git repository. Creating a commit is as easy as selecting files, writing the message in a text box, and clicking a button. +For new Git users, [GitHub Desktop](https://docs.github.com/en/desktop) is recommended because it presents a simple, graphical way to manage a Git repository. Creating a commit is as easy as selecting files, writing the commit message in a text box, and clicking a button. [Source control in VSCode](https://code.visualstudio.com/docs/sourcecontrol/overview) also offers a simple interface for Git. From 708e36cb38b10268df7ccff1a881cd3496991dd3 Mon Sep 17 00:00:00 2001 From: amsam0 <44983869+amsam0@users.noreply.github.com> Date: Wed, 5 Aug 2026 21:43:58 -0700 Subject: [PATCH 6/7] Update src/content/docs/best-practices/git-usage.mdx Co-authored-by: Adriana <16786568+Adrianamm@users.noreply.github.com> --- src/content/docs/best-practices/git-usage.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/best-practices/git-usage.mdx b/src/content/docs/best-practices/git-usage.mdx index c825eb4f..31969024 100644 --- a/src/content/docs/best-practices/git-usage.mdx +++ b/src/content/docs/best-practices/git-usage.mdx @@ -11,7 +11,7 @@ This helps keep track of when new code is added. When you add changes through smaller, focused commits, you can isolate when a bug is introduced and easily roll back to a working state. See [this article](https://www.freshconsulting.com/insights/blog/atomic-commits/) on atomic commits for more information. Writing descriptive commit messages make it easy to see exactly what changed. -Avoid focusing on how you made the change (that's what the diff is for). Instead, highlight the what and why. +Avoid focusing on how you made the change (that's what the diff is for). Instead highlight the what and why. By convention, commit messages are concise, begin with a capital letter, don't use punctuation, and are in the imperative mood. If you want to include more information in a commit message, consider using the commit body. From 3479a3b5eea9b5fbcdde874754d949bbe96a8b55 Mon Sep 17 00:00:00 2001 From: amsam0 <44983869+amsam0@users.noreply.github.com> Date: Fri, 7 Aug 2026 11:00:22 -0700 Subject: [PATCH 7/7] Run lint and format --- src/content/docs/best-practices/git-usage.mdx | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/content/docs/best-practices/git-usage.mdx b/src/content/docs/best-practices/git-usage.mdx index 31969024..fe4d342e 100644 --- a/src/content/docs/best-practices/git-usage.mdx +++ b/src/content/docs/best-practices/git-usage.mdx @@ -8,10 +8,12 @@ description: Best practices for Git A commit is a saved state of your repository. You should make a commit every time you complete a task (e.g. `Add per-path auto choosers`, `Fix joystick inputs inversion`, `Tune chassis heading PID gains`). This helps keep track of when new code is added. -When you add changes through smaller, focused commits, you can isolate when a bug is introduced and easily roll back to a working state. See [this article](https://www.freshconsulting.com/insights/blog/atomic-commits/) on atomic commits for more information. +When you add changes through smaller, focused commits, you can isolate when a bug is introduced and easily roll back to a working state. +See [this article](https://www.freshconsulting.com/insights/blog/atomic-commits/) on atomic commits for more information. Writing descriptive commit messages make it easy to see exactly what changed. -Avoid focusing on how you made the change (that's what the diff is for). Instead highlight the what and why. +Avoid focusing on how you made the change (that's what the diff is for). +Instead highlight the what and why. By convention, commit messages are concise, begin with a capital letter, don't use punctuation, and are in the imperative mood. If you want to include more information in a commit message, consider using the commit body. @@ -55,13 +57,15 @@ Repositories should have names that represent the purpose of its code, like "202 A Git client provides an interface for interacting with a Git repository. -For new Git users, [GitHub Desktop](https://docs.github.com/en/desktop) is recommended because it presents a simple, graphical way to manage a Git repository. Creating a commit is as easy as selecting files, writing the commit message in a text box, and clicking a button. +For new Git users, [GitHub Desktop](https://docs.github.com/en/desktop) is recommended because it presents a simple, graphical way to manage a Git repository. +Creating a commit is as easy as selecting files, writing the commit message in a text box, and clicking a button. [Source control in VSCode](https://code.visualstudio.com/docs/sourcecontrol/overview) also offers a simple interface for Git. [lazygit](https://github.com/jesseduffield/lazygit) is an intermediate option that retains much of the power of Git's command-line interface while being intuitive to use. -Git's command-line interface is the most raw and powerful Git client. However, it may be difficult to learn. +Git's command-line interface is the most raw and powerful Git client. +However, it may be difficult to learn. ## Additional Resources