Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,44 @@
---
name: Bug Report
about: Report an issue with OSA setup
about: Report an issue with OSA snippets
title: "[BUG] "
labels: bug
assignees: ''

assignees: ""
---

## Environment

- **Platform**: macOS / Linux / WSL
- **Shell**: zsh version (output of `zsh --version`)
- **OSA version**: (output of `git describe --tags`)
- **Running in VM**: Yes / No (e.g., VMware, VirtualBox, Parallels, etc.)
- **VM Type** (if applicable): _
- **VM Type** (if applicable): \_

## Reproduction Steps
1.
2.
3.

1.
2.
3.

## Expected Behavior
_

\_

## Actual Behavior
_

\_

## Error Output

```
(paste any error messages or logs here)
```

## Configuration Used

- Config file: (e.g., `configs/minimal.json`)
- Or describe custom setup: _
- Or describe custom setup: \_

## Additional Context
_

\_
64 changes: 37 additions & 27 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,43 @@ If there are conflicting or ambigious rules, mention them immediately in any ses
## Rules

1. Quality
- Clean code
- Proper error handling
- Documentation of functions and modules but not changes per prompt

2. Conventions
- Use consistent naming conventions for scripts and files
- Clean code
- Proper error handling
- Documentation of functions and modules but not changes per prompt

2. Conventions

- Use consistent naming conventions for scripts and files

3. Patterns
- Prevent recursive scripts from deleting important and unrelated files
- Protect against security issues
- Prevent infinite loops
- Avoid hardcoding values
- Ensure script performance
- Bail on malformed paths

3. Testing
- Add tests for any cli changes
- Test inputs and outputs
- Ensure full branching, statements, and path coverage

4. Files
- Always use .zsh extension for shell files
- 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.


5. Prompting/Responses
- Do not create or generate or modify files documenting changes made in prompt.
- Do not add comments indicating changes were made in response to a prompt.
- Avoid mentioning the use of AI or Copilot in code comments or documentation.
- Write code that is understandable and legible for humans

- Prevent recursive scripts from deleting important and unrelated files
- Protect against security issues
- Prevent infinite loops
- Avoid hardcoding values
- Ensure script performance
- Bail on malformed paths

4. Testing

- Add tests for any cli changes
- Test inputs and outputs
- Ensure full branching, statements, and path coverage

5. Files

- Always use .zsh extension for shell files
- 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.

6. Prompting/Responses
- Do not create or generate or modify files documenting changes made in prompt.
- Do not add comments indicating changes were made in response to a prompt.
- Avoid mentioning the use of AI or Copilot in code comments or documentation.
- Write code that is understandable and legible for humans

## Setup

- this repo uses yarn for commands related to javascript/typescript code
- this repo requires tests and coverage to be 100%.
- this repo uses bats to run bash/zsh tests
Loading