You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+24-3Lines changed: 24 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,18 @@ sudo just iso yellowfin base local
39
39
## Working Effectively
40
40
41
41
### Dependencies and Setup
42
-
- Install Just command runner to a temp dir not the root of the repo: `mkdir -p /tmp/just && cd /tmp/just && wget https://github.com/casey/just/releases/download/1.32.0/just-1.32.0-x86_64-unknown-linux-musl.tar.gz -O just.tar.gz && tar xzf just.tar.gz && sudo mv just /usr/local/bin/ && cd - && rm -rf /tmp/just`
42
+
-**Install Just via Homebrew** (recommended for consistency with CI):
-**CRITICAL**: NEVER extract just or any other tools directly into the repository root as this will overwrite project files like LICENSE and README.md
44
55
- Podman is required for container builds (usually pre-installed in CI environments)
45
56
- Shellcheck is required for linting: `sudo apt-get update && sudo apt-get install -y shellcheck`
@@ -143,8 +154,17 @@ For changes that don't affect the build process (e.g., documentation, CI config)
143
154
144
155
## Development Workflow
145
156
157
+
### Pre-Commit Requirements (MANDATORY):
158
+
Before making any commit, you MUST run these commands in order:
159
+
160
+
1.**Format code**: `just fix` - Formats shell scripts and Just files
161
+
2.**Validate syntax**: `just check` - Checks all scripts, YAML, JSON, and Just files
162
+
3.**Review changes**: `git status` and `git diff` - Verify what will be committed
163
+
164
+
**CRITICAL**: Running `just fix` and `just check` before every commit is mandatory. This prevents CI failures and ensures code quality. See `AGENTS.md` for detailed guidelines.
165
+
146
166
### Making Changes:
147
-
1.**Always run syntax checks first**:`just check`
167
+
1.**Always run `just fix` then`just check` before committing**: This is mandatory, not optional
148
168
2.**Test locally before pushing**: Build at least one variant to verify changes work
149
169
3.**Respect build timing**: Allow 45-60 minutes for full builds, never cancel early
150
170
4.**CI Integration**: All changes must pass GitHub Actions workflow within 60-minute timeout
@@ -236,7 +256,8 @@ Build arguments passed to Podman:
236
256
### Critical Don'ts:
237
257
-**NEVER cancel builds early**: Builds take 45-60 minutes, canceling early wastes resources
238
258
-**NEVER extract tools to repo root**: Always use /tmp or other temporary directories to avoid overwriting project files
239
-
-**NEVER skip validation**: Always run `just check` before committing changes
259
+
-**NEVER skip `just fix` and `just check`**: ALWAYS run both commands before committing - this is mandatory
260
+
-**NEVER commit without validation**: Running `just fix` then `just check` before every commit prevents CI failures
240
261
-**NEVER commit build artifacts**: Use `.gitignore` to exclude `.build/`, `.rpm-cache-*`, and similar directories
0 commit comments