Skip to content

Commit 043fdc7

Browse files
Copilotnirukk52
andcommitted
Add steering-docs to Biome ignore list and create bug report
Co-authored-by: nirukk52 <[email protected]>
1 parent 5de4c09 commit 043fdc7

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

biome.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"backend/steering",
1414
"backend/tmp",
1515
"frontend/build",
16+
"steering-docs",
1617
"**/.idea/**",
1718
"**/.vscode/**",
1819
"**/coverage/**",
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Bug Report: Steering Docs Directory Needs Cleanup
2+
3+
**Created**: 2025-11-05
4+
**Reporter**: @copilot
5+
**Status**: Open
6+
7+
## Issue Summary
8+
The `steering-docs/` directory is causing linting issues in CI and needs to be properly handled or cleaned up.
9+
10+
## Impact
11+
- **Severity**: Low
12+
- **Affected Area**: CI-CD, Documentation
13+
14+
## Current Behavior
15+
The `steering-docs/` directory is tracked in git and being linted by Biome, which may cause CI failures.
16+
17+
## Expected Behavior
18+
Either:
19+
1. The directory should be properly formatted/linted if it contains active documentation, OR
20+
2. The directory should be excluded from linting if it's not part of the active codebase
21+
22+
## Steps to Reproduce
23+
1. Run `bun run lint` in root or backend/frontend
24+
2. Observe potential linting issues with steering-docs files
25+
26+
## Root Cause
27+
The `steering-docs/` directory was not included in the Biome ignore list in `biome.json`, causing it to be checked during linting.
28+
29+
## Proposed Solution
30+
31+
**Temporary Fix (Applied)**:
32+
- Added `steering-docs` to the ignore list in `biome.json`
33+
34+
**Future Work**:
35+
1. Review the purpose and status of `steering-docs/` directory
36+
2. Determine if it should be:
37+
- Kept and properly maintained with linting
38+
- Archived or moved to a different location
39+
- Removed if no longer needed
40+
3. Update documentation to reflect the decision
41+
42+
## Related Resources
43+
- `biome.json` configuration file
44+
- `steering-docs/` directory structure
45+
46+
## Action Items
47+
- [x] Add `steering-docs` to Biome ignore list (temporary fix)
48+
- [ ] Review steering-docs directory purpose and contents
49+
- [ ] Make decision on long-term handling of steering-docs
50+
- [ ] Update project documentation accordingly
51+
52+
## Notes
53+
- This is a low-priority cleanup task
54+
- The temporary fix unblocks CI while proper cleanup can be planned
55+
- Consider whether steering-docs should be in a separate repository or documentation system

0 commit comments

Comments
 (0)