Skip to content

Commit 3c6cde1

Browse files
Copilotmyabc
andcommitted
Add coding standards section emphasizing GitHub conventions
Co-authored-by: myabc <755+myabc@users.noreply.github.com>
1 parent e4fab1d commit 3c6cde1

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,21 @@ We periodically sync with GitHub's Primer repository. The process:
287287

288288
**Important:** Only update one version at a time to preserve changeset history.
289289

290+
## Coding Standards
291+
292+
**We follow the coding standards defined by the upstream project (GitHub), not the guidelines used by OpenProject core.** This approach:
293+
- Facilitates upstreaming of our changes to the original Primer repository
294+
- Reduces the overhead of maintaining two sets of rules within one repository
295+
- Maintains consistency with the broader Primer ecosystem
296+
297+
**Concrete implications:**
298+
- **Testing**: Use **Minitest**, not RSpec (as used in OpenProject core)
299+
- **CSS**: Follow GitHub's CSS formatting rules and conventions
300+
- **TypeScript**: Follow GitHub's TypeScript formatting rules and style guide
301+
- **Ruby**: Follow the Primer ViewComponents patterns and conventions
302+
303+
When in doubt, refer to the existing codebase and upstream Primer ViewComponents for guidance on style and patterns.
304+
290305
## Code Style Guidelines
291306

292307
### Ruby

0 commit comments

Comments
 (0)