Skip to content

Commit 3ae90d0

Browse files
Feature/osa package with ai tooling guards (#1)
* - Add scripts to validate safety of ai tooling - mise to 22 - yarn to 4.10.x * Mass migrate to better folder structure to organize apps zsh js code * use commander cli and swap to full cli * add linter * Fix test pipelines * Fix release * downgrade to v4 checkout in case error * remove validate syntax unnecessary complication * fix bad path * move pipeline run of tests to top level * remove redundant code * fix/remove unnecessary pipeline steps * fix gitigore for yarn install state * add base tsconfig * improve documentation * improve the cli to identify issues quickly * - fix testing with 95% coverage threshold * make ci run test:coverage
1 parent bf60c94 commit 3ae90d0

77 files changed

Lines changed: 17981 additions & 851 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,44 @@
11
---
22
name: Bug Report
3-
about: Report an issue with OSA setup
3+
about: Report an issue with OSA snippets
44
title: "[BUG] "
55
labels: bug
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
## Environment
10+
1111
- **Platform**: macOS / Linux / WSL
1212
- **Shell**: zsh version (output of `zsh --version`)
1313
- **OSA version**: (output of `git describe --tags`)
1414
- **Running in VM**: Yes / No (e.g., VMware, VirtualBox, Parallels, etc.)
15-
- **VM Type** (if applicable): _
15+
- **VM Type** (if applicable): \_
1616

1717
## Reproduction Steps
18-
1.
19-
2.
20-
3.
18+
19+
1.
20+
2.
21+
3.
2122

2223
## Expected Behavior
23-
_
24+
25+
\_
2426

2527
## Actual Behavior
26-
_
28+
29+
\_
2730

2831
## Error Output
32+
2933
```
3034
(paste any error messages or logs here)
3135
```
3236

3337
## Configuration Used
38+
3439
- Config file: (e.g., `configs/minimal.json`)
35-
- Or describe custom setup: _
40+
- Or describe custom setup: \_
3641

3742
## Additional Context
38-
_
43+
44+
\_

.github/copilot-instructions.md

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,43 @@ If there are conflicting or ambigious rules, mention them immediately in any ses
55
## Rules
66

77
1. Quality
8-
- Clean code
9-
- Proper error handling
10-
- Documentation of functions and modules but not changes per prompt
118

12-
2. Conventions
13-
- Use consistent naming conventions for scripts and files
9+
- Clean code
10+
- Proper error handling
11+
- Documentation of functions and modules but not changes per prompt
12+
13+
2. Conventions
14+
15+
- Use consistent naming conventions for scripts and files
1416

1517
3. Patterns
16-
- Prevent recursive scripts from deleting important and unrelated files
17-
- Protect against security issues
18-
- Prevent infinite loops
19-
- Avoid hardcoding values
20-
- Ensure script performance
21-
- Bail on malformed paths
22-
23-
3. Testing
24-
- Add tests for any cli changes
25-
- Test inputs and outputs
26-
- Ensure full branching, statements, and path coverage
27-
28-
4. Files
29-
- Always use .zsh extension for shell files
30-
- Update the README.md if modifications/updates/changes are added to osa-cli tool scope which change/add/remove usage/description/args/options of the cli we need the cli doc to always match the actual implementation.
31-
32-
33-
5. Prompting/Responses
34-
- Do not create or generate or modify files documenting changes made in prompt.
35-
- Do not add comments indicating changes were made in response to a prompt.
36-
- Avoid mentioning the use of AI or Copilot in code comments or documentation.
37-
- Write code that is understandable and legible for humans
18+
19+
- Prevent recursive scripts from deleting important and unrelated files
20+
- Protect against security issues
21+
- Prevent infinite loops
22+
- Avoid hardcoding values
23+
- Ensure script performance
24+
- Bail on malformed paths
25+
26+
4. Testing
27+
28+
- Add tests for any cli changes
29+
- Test inputs and outputs
30+
- Ensure full branching, statements, and path coverage
31+
32+
5. Files
33+
34+
- Always use .zsh extension for shell files
35+
- Update the README.md if modifications/updates/changes are added to osa-cli tool scope which change/add/remove usage/description/args/options of the cli we need the cli doc to always match the actual implementation.
36+
37+
6. Prompting/Responses
38+
- Do not create or generate or modify files documenting changes made in prompt.
39+
- Do not add comments indicating changes were made in response to a prompt.
40+
- Avoid mentioning the use of AI or Copilot in code comments or documentation.
41+
- Write code that is understandable and legible for humans
42+
43+
## Setup
44+
45+
- this repo uses yarn for commands related to javascript/typescript code
46+
- this repo requires tests and coverage to be 100%.
47+
- this repo uses bats to run bash/zsh tests

0 commit comments

Comments
 (0)