Skip to content

Add best practices section#102

Open
reniejoshi wants to merge 4 commits into
frcsoftware:mainfrom
reniejoshi:add-best-practices-page
Open

Add best practices section#102
reniejoshi wants to merge 4 commits into
frcsoftware:mainfrom
reniejoshi:add-best-practices-page

Conversation

@reniejoshi

@reniejoshi reniejoshi commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

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.

Fix validate-regions.ts CRLF compatibility on Windows, as this was previously creating unnecessary linting errors.

Closes #90.

Meta

Merge checklist:

@github-actions

Copy link
Copy Markdown

🌐 Preview URL: https://pr-102.frcsoftware.pages.dev

@reniejoshi
reniejoshi force-pushed the add-best-practices-page branch from d2129f1 to 7bef541 Compare July 19, 2026 19:39
@reniejoshi
reniejoshi force-pushed the add-best-practices-page branch from 7bef541 to 6030eb7 Compare July 19, 2026 19:44
Comment thread src/content/docs/best-practices/git-usage.mdx
Comment thread src/content/docs/best-practices/git-usage.mdx
Comment thread src/content/docs/best-practices/git-usage.mdx
Comment thread src/content/docs/best-practices/git-usage.mdx
Comment thread src/content/docs/best-practices/git-usage.mdx
@reniejoshi
reniejoshi requested a review from Adrianamm July 19, 2026 22:04

@roboteer5291 roboteer5291 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Content is overall great, just needs some tweaks

Comment thread src/content/docs/best-practices/overview.mdx Outdated
Comment thread src/content/docs/best-practices/overview.mdx Outdated
Comment thread src/content/docs/best-practices/git-usage.mdx Outdated
Comment thread src/content/docs/best-practices/git-usage.mdx Outdated
Comment thread src/content/docs/best-practices/code-formatter.mdx Outdated
Comment thread src/content/docs/best-practices/github-usage.mdx
Comment thread src/content/docs/best-practices/github-usage.mdx
Comment thread src/content/docs/best-practices/github-usage.mdx Outdated
Comment thread src/content/docs/best-practices/ci-checks.mdx
Comment thread src/config/sidebarConfig.ts
@reniejoshi
reniejoshi requested a review from roboteer5291 July 20, 2026 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add best practices page

3 participants