Set up a team repository¶
Create a new GitHub repository preconfigured with GitM's PDM rules, so your team can connect and start working.
Prerequisites¶
- GitM installed; you can open the GitM PDM task pane.
- A GitHub account that can create repositories in your team's organization.
- Your account allowlisted in GitMCloud (the create flow runs the same access check as connecting).
This requires GitMCloud — see GitMCloud docs.
Steps¶
- Open the first-run wizard (or Settings (⚙️) → Repository → Connect another repository…).
- Choose Start a new repository.
- Pick a profile (see below).
- Enter the repository name and visibility (private/public), and choose a local folder.
- Let the wizard create the repository on GitHub and push the initial commit.
The wizard writes, on creation:
- .gitattributes — LFS + lockable rules for SolidWorks extensions (this is what makes
locking work).
- .gitignore — excludes SolidWorks backups and temp files, including ~$*.
- .gitm.json — the chosen profile's conventions.
- A starter folder structure and README, depending on the profile.
Profiles¶
| Profile | Use for |
|---|---|
| Generic / Startup | Minimal opinions, generic folders. The default. |
| FRC Robotics | Pre-set folders (/drivetrain, /intake, …) and naming hints for FRC teams. |
| Consultancy | Per-client folder hints, stricter main protection, audit-friendly templates. |
| Custom | A profile your team authors as .gitm.json and checks into the repo. |
A profile is just .gitm.json at the repository root. GitM reads it on connect and applies
the defaults. Without one, Generic settings apply.
Expected result¶
- A new GitHub repository exists with
.gitattributes,.gitignore,.gitm.json, and a starter structure. - Your task pane is connected to it.
- Teammates can now sign in to it (once allowlisted in GitMCloud).
Protecting .gitattributes¶
The .gitattributes rules are the foundation of locking. If they're removed or wrong, large
files get committed outside LFS and locking breaks. Treat the file as protected:
- Don't let it be deleted or hand-edited to drop the
lockableflag. - Use Settings → Diagnostics to confirm the SolidWorks extensions have LFS + lockable rules.
Troubleshooting¶
| Symptom | Cause | Fix |
|---|---|---|
| Create blocked with a GitMCloud message | Account not allowlisted / GitMCloud unreachable. | Get allowlisted; see Prepare GitMCloud before installing. |
| "Create on GitHub" fails | No permission to create in that org, or name taken. | Use an org you can create in; pick a free name. |
| Members can't connect | They're not allowlisted, or lack GitHub repo access. | Add them in GitMCloud and on GitHub. |
Known limitations¶
- The set of built-in profiles and templates is fixed in the build; custom conventions live
in
.gitm.json. - Branch protection is configured on GitHub, not from GitM; GitM only reflects it.