Skip to content

Commit ae3c228

Browse files
authored
Merge pull request #11 from mennlo/update-instructions
fix(): update the copilot instructions
2 parents 67a3c25 + 29e1809 commit ae3c228

File tree

2 files changed

+109
-81
lines changed

2 files changed

+109
-81
lines changed

.github/copilot-instructions.md

Lines changed: 109 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -2,117 +2,151 @@
22

33
This document provides instructions for GitHub Copilot to follow when generating or modifying markdown files for the Grappling Games project. These guidelines ensure consistent structure and formatting across all class and game files.
44

5+
For detailed file structure and formatting guidelines, please refer to [game-format-guidelines.md](game-format-guidelines.md).
6+
57
## General Formatting Guidelines
68

79
1. Use `#` for main titles, `##` for section headings, and `###` for subsection headings
810
2. Use double asterisks (`**`) for bold text, especially for field labels
911
3. Use two spaces at the end of a line to create line breaks within sections
1012
4. Use double line breaks to separate major sections
1113

12-
## Class File Structure (.md files in /classes/ directory)
14+
## Time Format Standard
1315

14-
Class files should follow this structure:
16+
Always format time specifications as this unless told otherwise:
17+
`**Time:** 3 minutes, 2 partners or 6 minutes total - switching back and forth`
1518

16-
```markdown
17-
# [Name of Class] Class
18-
**Class Length:** 1 hour
19+
## GitHub Pages URLs Format
1920

20-
This class consists of several progressive drills that build upon each other. Each drill is available as an individual game file for reference.
21+
When linking to game files from class files, always use the format:
22+
`https://mennlo.github.io/grappling-games/md-viewer.html?file=games/path/to/game-file.md`
2123

22-
1. [Game Name 1](https://mennlo.github.io/grappling-games/md-viewer.html?file=games/path/to/game1.md)
23-
2. [Game Name 2](https://mennlo.github.io/grappling-games/md-viewer.html?file=games/path/to/game2.md)
24-
3. [Game Name 3](https://mennlo.github.io/grappling-games/md-viewer.html?file=games/path/to/game3.md)
25-
...
24+
## Position, Objective, Constraints, Win Format
2625

27-
## [Section Type] Drills
26+
Always list these fields in order:
27+
1. **Position:** (always required)
28+
2. **Objective:** (always required)
29+
3. **Constraints:** (don't include even if empty)
30+
4. **Win:** or **Win Condition:** (always required)
2831

29-
### [Section Type] 1 - [Game Name 1](https://mennlo.github.io/grappling-games/md-viewer.html?file=games/path/to/game1.md)
32+
Each field should be on its own line with two trailing spaces for line breaks.
33+
34+
## Game Format Guidelines
3035

31-
**Overview:** Brief description of the drill.
36+
## Asymmetric Games (Different Roles for Each Player)
37+
When creating games where players have different roles, positions, and objectives:
3238

39+
### Details Section Format
40+
```markdown
41+
## Details
3342
**Time:** 3 minutes, 2 partners or 6 minutes total - switching back and forth
3443

35-
#### [Player Role]
36-
**Position:** Starting position description
37-
**Objective:** What the player should try to accomplish
38-
**Constraints:** Any limitations on actions (optional)
39-
**Win:** Win condition
40-
41-
#### [Other Player Role]
42-
**Position:** Starting position description
43-
**Objective:** What the player should try to accomplish
44-
**Constraints:** Any limitations on actions (optional)
45-
**Win:** Win condition
46-
47-
**Instructions:**
48-
1. Step 1
49-
2. Step 2
50-
3. Step 3
51-
4. Step 4
52-
```
44+
### Role 1 (e.g., Attacking Player, Bottom Player)
45+
**Position:** [Starting position description]
46+
**Objective:** [What this player should try to accomplish]
47+
**Win:** [Win condition for this player]
5348

54-
## Game File Structure (.md files in /games/ directory)
49+
### Role 2 (e.g., Defending Player, Top Player)
50+
**Position:** [Starting position description]
51+
**Objective:** [What this player should try to accomplish]
52+
**Win:** [Win condition for this player]
53+
```
5554

56-
Game files should follow this structure:
55+
### Instructions Section Format
56+
Instructions should clearly differentiate between what each player should do:
57+
```markdown
58+
## Instructions
59+
1. [Role 1] starts with [specific starting position]
60+
2. [Role 1] works to [achieve objective]
61+
3. [Role 2] tries to [achieve counter-objective]
62+
4. [Specific interactions or transitions]
63+
5. Reset and repeat, switching roles after the predetermined time
64+
```
5765

66+
### Coaching Points Section Format
67+
Separate coaching points for each role:
5868
```markdown
59-
# [Game Name]
69+
## Coaching Points
70+
For [Role 1]:
71+
- [Tip 1]
72+
- [Tip 2]
73+
- [Tip 3]
74+
75+
For [Role 2]:
76+
- [Tip 1]
77+
- [Tip 2]
78+
- [Tip 3]
79+
```
6080

61-
## Overview
62-
Brief description of the game or drill.
81+
## Symmetric Games (Same Role for Both Players)
82+
When creating games where both players have the same position, objective, and win conditions:
6383

84+
### Details Section Format
85+
```markdown
6486
## Details
65-
**Time:** 3 minutes, 2 partners or 6 minutes total - switching back and forth
66-
67-
### [Player Role]
68-
**Position:** Starting position description
69-
**Objective:** What the player should try to accomplish
70-
**Constraints:** Any limitations on actions (optional)
71-
**Win:** Win condition
87+
**Time:** 3 minutes, 2 partners or 6 minutes total - switching back and forth
7288

73-
### [Other Player Role]
74-
**Position:** Starting position description
75-
**Objective:** What the player should try to accomplish
76-
**Constraints:** Any limitations on actions (optional)
77-
**Win:** Win condition
89+
**Position:** [Starting position description]
90+
**Objective:** [What both players should try to accomplish]
91+
**Win:** [Win condition for both players]
92+
```
7893

94+
### Instructions Section Format
95+
Instructions should be clear that both players are doing the same thing:
96+
```markdown
7997
## Instructions
80-
1. Step 1
81-
2. Step 2
82-
3. Step 3
83-
4. Step 4
98+
1. Both players start [specific starting position]
99+
2. Both players simultaneously work to [achieve objective]
100+
3. [Specific rules or constraints]
101+
4. The first player to achieve their win condition ends the round
102+
5. Reset and repeat for the predetermined time
103+
```
84104

105+
### Coaching Points Section Format
106+
Common coaching points for both players:
107+
```markdown
85108
## Coaching Points
86-
For [player role]:
87-
- Coaching tip 1
88-
- Coaching tip 2
89-
- Coaching tip 3
90-
91-
For [other player role]:
92-
- Coaching tip 1
93-
- Coaching tip 2
94-
- Coaching tip 3
109+
For both players:
110+
- [Tip 1]
111+
- [Tip 2]
112+
- [Tip 3]
113+
- [Tip 4]
95114
```
96115

97-
## Time Format Standard
116+
## Class File Format
117+
The class file should match the format used in the individual game files:
98118

99-
Always format time specifications as this unless told otherwise:
100-
`**Time:** 3 minutes, 2 partners or 6 minutes total - switching back and forth`
119+
### For Asymmetric Games:
120+
```markdown
121+
### [Section] [Number] - [Game Name](link)
101122

102-
## GitHub Pages URLs Format
123+
**Overview:** Brief description
103124

104-
When linking to game files from class files, always use the format:
105-
`https://mennlo.github.io/grappling-games/md-viewer.html?file=games/path/to/game-file.md`
125+
**Time:** 3 minutes, 2 partners or 6 minutes total - switching back and forth
106126

107-
## Position, Objective, Constraints, Win Format
127+
#### Role 1
128+
**Position:** [Starting position description]
129+
**Objective:** [What this player should try to accomplish]
130+
**Win:** [Win condition for this player]
108131

109-
Always list these fields in order:
110-
1. **Position:** (always required)
111-
2. **Objective:** (always required)
112-
3. **Constraints:** (don't include even if empty)
113-
4. **Win:** or **Win Condition:** (always required)
132+
#### Role 2
133+
**Position:** [Starting position description]
134+
**Objective:** [What this player should try to accomplish]
135+
**Win:** [Win condition for this player]
136+
```
114137

115-
Each field should be on its own line with two trailing spaces for line breaks.
138+
### For Symmetric Games:
139+
```markdown
140+
### [Section] [Number] - [Game Name](link)
141+
142+
**Overview:** Brief description
143+
144+
**Time:** 3 minutes, 2 partners or 6 minutes total - switching back and forth
145+
146+
**Position:** [Starting position description]
147+
**Objective:** [What both players should try to accomplish]
148+
**Win:** [Win condition for both players]
149+
```
116150

117151
## Naming Conventions
118152

@@ -127,4 +161,4 @@ Each field should be on its own line with two trailing spaces for line breaks.
127161
- Pinning Games: `/games/pinning/game-name.md`
128162
- Standing Games: `/games/standing/game-name.md`
129163

130-
When generating new files, follow this directory structure and use the appropriate templates above.
164+
When generating new files, follow this directory structure and use the appropriate templates as specified above.

games/standing/progressive-touch-to-bodylock.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,6 @@ A competitive standing drill where both partners start with no connections and r
66
## Details
77
**Time:** 3 minutes, 2 partners or 6 minutes total - switching back and forth
88

9-
### Player One
10-
**Position:** Standing facing your partner with no initial connections
11-
**Objective:** Complete three touches (any combination of underhook, hand behind knee, or Russian tie) before establishing a bodylock, or bypass these requirements by shooting for a double leg takedown
12-
**Win:** Successfully complete three touches and establish a bodylock, or successfully execute a double leg takedown
13-
14-
### Player Two
159
**Position:** Standing facing your partner with no initial connections
1610
**Objective:** Complete three touches (any combination of underhook, hand behind knee, or Russian tie) before establishing a bodylock, or bypass these requirements by shooting for a double leg takedown
1711
**Win:** Successfully complete three touches and establish a bodylock, or successfully execute a double leg takedown

0 commit comments

Comments
 (0)