Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.77 KB

coding-conventions.md

File metadata and controls

37 lines (22 loc) · 1.77 KB

Raptor Code Conventions

What are Coding Conventions? Well, one of the first rules you learn in the real world is 1) Don't Reinvent the Wheel. So I'll let some better authors then I explain it better, click here.

java-logo

@gabrielseaver9678 put your conventions/recommendations here

Comment your code

markdown-logo Markdown

  1. Use the GitHub Markdown style. Their MD guidelines can be found here.
  2. Everyone gets a README.md file..

git-GitHub-logo

  1. Create a personal account on GitHub and ask a programming mentor to add your account to the Raptor1711 organization. Click here to create a GitHub account, if you don't already have one.

  2. Read the docs about getting started with Git and GitHub.

  3. The main branch is protected. Only a 1711 organization admin can approve Pull Requests to the main branch. Create a your own branch of the main branch, and when your changes are complete and tested, submit a Pull Request to have your code added to the main branch.

  4. Git and GitHub terms and processes to know

    • Commits
    • Branches
    • Merging / Pull Requests
    • Stashing (WIP)

vs-code-logoVS Code

  1. Setting up WPI / Java / VS Code using the FRC WPI Installer.
  2. Common VS Code extensions you might want over the standard Java and WPI extensions.
    • java linter
    • markdown linter