Skip to content

Commit 355379c

Browse files
author
Renae Metcalf
committed
Clean up
1 parent 9ade107 commit 355379c

1 file changed

Lines changed: 19 additions & 38 deletions

File tree

.github/copilot-instructions.md

Lines changed: 19 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,33 @@ SSVC is a modular decision-making framework for vulnerability management that in
2626
## Project Structure
2727

2828
- `/src/ssvc/` - Core Python modules for SSVC functionality
29+
- `decision_points/` - Decision point definitions
30+
- `decision_tables/` - Decision table implementations
31+
- `api/` - FastAPI application
32+
- `outcomes/` - Outcome definitions
33+
- `dp_groups/` - Decision point groups
34+
- `registry/` - Registry functionality
2935
- `/docs/` - Markdown documentation source files
3036
- `/data/` - JSON and CSV data files for decision tables
31-
- `/test/` - Unit tests (located in `/src/test/`)
37+
- `/src/test/` - Unit tests
3238
- `/docker/` - Docker configurations
3339
- `/obsolete/` - Deprecated code (do not modify)
3440

35-
## Development Workflow
36-
37-
### Getting Started
41+
## Make Commands
3842

39-
1. **Set up development environment**: `make dev`
40-
2. **Run local documentation server**: `make docs_local` (local) or `make docs` (Docker)
41-
3. **Run tests**: `make test` (local) or `make docker_test` (Docker)
42-
4. **Run API**: `make api_dev` (local) or `make api` (Docker)
43+
Use `make help` to see all available commands. Common targets include:
4344

44-
### Building and Testing
45+
- `make dev` - Set up development environment
46+
- `make test` - Run tests locally
47+
- `make docker_test` - Run tests in Docker
48+
- `make docs_local` - Serve documentation locally (http://localhost:8000/SSVC/)
49+
- `make docs` - Build and run documentation in Docker
50+
- `make api_dev` - Run API locally with auto-reload
51+
- `make api` - Build and run API in Docker
52+
- `make mdlint_fix` - Run markdown linting with auto-fix
53+
- `make regenerate_json` - Regenerate JSON files from Python modules
4554

46-
- Always run tests before committing: `make test`
47-
- Run markdown linting with auto-fix: `make mdlint_fix`
48-
- Regenerate JSON data files: `make regenerate_json`
55+
## Development Workflow
4956

5057
## Coding Conventions
5158

@@ -58,18 +65,6 @@ SSVC is a modular decision-making framework for vulnerability management that in
5865
- Prefer explicit imports over wildcard imports
5966
- Module structure uses absolute imports from `ssvc` package
6067

61-
### File Organization
62-
63-
- `/src/ssvc/` - Core Python modules including:
64-
- `decision_points/` - Decision point definitions
65-
- `decision_tables/` - Decision table implementations
66-
- `api/` - FastAPI application
67-
- `outcomes/` - Outcome definitions
68-
- `dp_groups/` - Decision point groups
69-
- `registry/` - Registry functionality
70-
- `/src/test/` - Unit tests mirroring source structure
71-
- `/docs/` - Documentation pages
72-
7368
### Naming Conventions
7469

7570
- Python files: `snake_case.py`
@@ -147,20 +142,6 @@ SSVC is a modular decision-making framework for vulnerability management that in
147142
- Run locally with auto-reload: `make api_dev` (serves on http://127.0.0.1:8000/docs)
148143
- Run in Docker: `make api` (serves on http://127.0.0.1:8001/SSVC/)
149144

150-
## Make Commands
151-
152-
Use `make help` to see all available commands. Common targets include:
153-
154-
- `make dev` - Set up development environment
155-
- `make test` - Run tests locally
156-
- `make docker_test` - Run tests in Docker
157-
- `make docs_local` - Serve documentation locally (http://localhost:8000/SSVC/)
158-
- `make docs` - Build and run documentation in Docker
159-
- `make api_dev` - Run API locally with auto-reload
160-
- `make api` - Build and run API in Docker
161-
- `make mdlint_fix` - Run markdown linting with auto-fix
162-
- `make regenerate_json` - Regenerate JSON files from Python modules
163-
164145
## Git Workflow
165146

166147
- Create feature branches for new work

0 commit comments

Comments
 (0)