Add best practices section#102
Open
reniejoshi wants to merge 12 commits into
Open
Conversation
|
🌐 Preview URL: https://pr-102.frcsoftware.pages.dev |
reniejoshi
force-pushed
the
add-best-practices-page
branch
from
July 19, 2026 19:39
d2129f1 to
7bef541
Compare
reniejoshi
force-pushed
the
add-best-practices-page
branch
from
July 19, 2026 19:44
7bef541 to
6030eb7
Compare
Adrianamm
requested changes
Jul 19, 2026
roboteer5291
requested changes
Jul 20, 2026
roboteer5291
left a comment
Collaborator
There was a problem hiding this comment.
Content is overall great, just needs some tweaks
roboteer5291
previously approved these changes
Jul 21, 2026
Member
|
Our files should never use CRLF line endings, we should be following the unix standard here. If we need to add linting for the line endings used, pls do that in a separate PR. |
Member
|
So this adds what amounts to reference material. Do we also want to integrate this into the stages and other lessons? |
samfreund
requested changes
Jul 21, 2026
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 |
Comment on lines
+40
to
+41
| - To merge: `git fetch` then `git merge origin/main` | ||
| - To rebase: `git fetch` then `git rebase origin/main` |
Member
There was a problem hiding this comment.
Whats a merge? Whats a rebase?
Member
There was a problem hiding this comment.
My bad for not saying it earlier, but information on when each type of update is appropriate might be useful.
samfreund
requested changes
Jul 22, 2026
samfreund
left a comment
Member
There was a problem hiding this comment.
Overall looking good! Couple of nitpicks and suggestions but it should be ready to merge soon.
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 |
Comment on lines
+40
to
+41
| - To merge: `git fetch` then `git merge origin/main` | ||
| - To rebase: `git fetch` then `git rebase origin/main` |
Member
There was a problem hiding this comment.
My bad for not saying it earlier, but information on when each type of update is appropriate might be useful.
Member
There was a problem hiding this comment.
@zachwaffle4 thoughts? It's standard from what I've seen, but might be useful. Would like your opinion on the maintenance burden here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a best practices section that contains an overview page based on the corresponding FRCDesign.org page and guides for Git usage, code formatters, GitHub usage, and CI checks. This section serves to introduce programmers to good software development practices.
Add CI as a glossary term.
Closes #90.
Meta
Merge checklist: