Skip to content

Commit b8547c4

Browse files
divyamohan1993divyamohan1993
committed
docs: add CHANGELOG, CITATION.cff, CONTRIBUTING, issue + PR templates
1 parent 56f3b33 commit b8547c4

6 files changed

Lines changed: 213 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Bug report
2+
description: Something is wrong with SentinelCloud. Tell us what.
3+
title: "[bug] "
4+
labels: [bug, triage]
5+
body:
6+
- type: input
7+
id: scenario
8+
attributes:
9+
label: Scenario or page
10+
placeholder: "/demo/cve"
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: what
15+
attributes:
16+
label: What happened
17+
description: One paragraph. Plain words.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: expected
22+
attributes:
23+
label: What you expected
24+
validations:
25+
required: true
26+
- type: input
27+
id: revision
28+
attributes:
29+
label: Cloud Run revision (if known)
30+
placeholder: "sentinelcloud-00005-xyz"

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Feature request
2+
description: Suggest something SentinelCloud could do better.
3+
title: "[feat] "
4+
labels: [enhancement]
5+
body:
6+
- type: textarea
7+
id: motivation
8+
attributes:
9+
label: What is the user need?
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: proposal
14+
attributes:
15+
label: What change would solve it?
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: alternatives
20+
attributes:
21+
label: Alternatives you considered

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## What this changes
2+
3+
One paragraph. The why is more important than the what.
4+
5+
## How to verify
6+
7+
- [ ] `cd web && npm run typecheck` is clean
8+
- [ ] `cd web && npm run build` succeeds
9+
- [ ] Local run of an affected scenario shows the expected change
10+
- [ ] CHANGELOG.md updated if user-visible
11+
12+
## Screenshots (UI changes only)
13+
14+
Before / after.
15+
16+
## Notes for the reviewer
17+
18+
Anything non-obvious.

‎CHANGELOG.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Changelog
2+
3+
All notable changes to SentinelCloud are documented here.
4+
The format is loosely based on Keep a Changelog and the project follows
5+
semantic versioning.
6+
7+
## v1.0.0 — 2026-05-03
8+
9+
First public release.
10+
11+
### Architecture
12+
- Three-layer brain: perception, reasoning, actuation. Source paths cited
13+
in `docs/ARCHITECTURE.md`.
14+
- Six-agent state machine with a contractually pinned Devil's Advocate.
15+
- Twelve gap-fix modules covering tool-call validation, blast radius,
16+
semantic policy, episodic memory, calibrated confidence, deterministic
17+
scenarios, multimodal ingestion, FinOps cost-risk tradeoffs, WAF
18+
synthesis, and a process reward model.
19+
20+
### Reasoning
21+
- Gemini 2.5 Pro on Vertex AI as the default reasoner.
22+
- Anthropic Claude as an optional second opinion.
23+
- Deterministic scenario-aware stub as the always-on fallback.
24+
- Provider and model surfaced on every agent turn so the demo never lies
25+
about who wrote the line.
26+
27+
### Scenarios
28+
- Seven seeded fixtures: memory leak, database pool exhaustion, zero-day
29+
CVE, FinOps right-size, configuration drift, cascading failure,
30+
layer-7 anomaly. Each fixture is byte-stable.
31+
32+
### Deployment
33+
- Cloud Run, asia-east1, project dmjone, min-instances 0.
34+
- Production domain mapping for sentinelcloud.dmj.one (DNS pending).
35+
- GitHub Actions CI for typecheck, build, and security scan.
36+
- Zero open Dependabot alerts at release.
37+
- npm overrides pinning postcss >= 8.5.10, uuid >= 14, and
38+
@tootallnate/once >= 3.0.1 to close known transitive CVEs.
39+
40+
### Documentation
41+
- README (409 lines) for the public face.
42+
- CAPSTONE_REPORT (1345 lines) for the examination committee.
43+
- ARCHITECTURE, GAP_MATRIX, LITERATURE_REVIEW, DEPLOY, RUNBOOK, SECURITY.
44+
45+
### Author
46+
Rohit Kumar (GF202220522), BTech CSE Cloud Computing,
47+
School of Computing Science and Engineering, Galgotias University.
48+
Mentor and build partner: Divya Mohan, dmj.one.

‎CITATION.cff‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
cff-version: 1.2.0
2+
title: "SentinelCloud: A Closed-Loop Multi-Agent System for Autonomous Cloud DevOps"
3+
message: "If you use this work, please cite it as below."
4+
type: software
5+
authors:
6+
- family-names: Kumar
7+
given-names: Rohit
8+
affiliation: "School of Computing Science and Engineering, Galgotias University"
9+
note: "BTech CSE Cloud Computing, Roll No. GF202220522"
10+
- family-names: Mohan
11+
given-names: Divya
12+
affiliation: "dmj.one"
13+
email: contact@dmj.one
14+
repository-code: "https://github.com/divyamohan1993/sentinelcloud"
15+
url: "https://sentinelcloud.dmj.one"
16+
license: MIT
17+
date-released: 2026-05-03
18+
version: "1.0.0"
19+
keywords:
20+
- AIOps
21+
- autonomous DevOps
22+
- multi-agent systems
23+
- large language models
24+
- incident response
25+
- FinOps
26+
- cloud security
27+
- capstone
28+
- BTech CSE
29+
preferred-citation:
30+
type: software
31+
title: "SentinelCloud: A Closed-Loop Multi-Agent System for Autonomous Cloud DevOps"
32+
authors:
33+
- family-names: Kumar
34+
given-names: Rohit
35+
- family-names: Mohan
36+
given-names: Divya
37+
year: 2026
38+
url: "https://sentinelcloud.dmj.one"
39+
notes: "BTech CSE Cloud Computing capstone, Galgotias University, May 2026."

‎CONTRIBUTING.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing to SentinelCloud
2+
3+
Thanks for considering a contribution. The bar for this project is
4+
production-grade engineering on a research-grade design. The notes below
5+
explain how to keep that bar.
6+
7+
## Quick start
8+
9+
```bash
10+
git clone https://github.com/divyamohan1993/sentinelcloud
11+
cd sentinelcloud/web
12+
npm install
13+
npm run dev
14+
# open http://localhost:8080
15+
```
16+
17+
The deterministic stub is the default when no Vertex AI credentials are
18+
present, so the demo always works offline.
19+
20+
## Areas where help is welcome
21+
22+
- Adding new seeded scenarios in `web/lib/scenarios/`.
23+
- Connector-mode adapters for live GCP, AWS, Azure, or Kubernetes.
24+
- A learned process reward model to replace the heuristic in
25+
`web/lib/memory/episodic.ts`.
26+
- New WAF rule patterns and CVE-to-rule transforms.
27+
- Translations of the public-facing copy. Indic languages first, then
28+
the rest.
29+
30+
## Code conventions
31+
32+
- TypeScript strict mode. No `any` in new public APIs.
33+
- Each module documents its purpose in a single header comment.
34+
- Agents return the typed `AgentTurn` envelope. No free-form payloads.
35+
- Scenarios are seeded fixtures. Time-dependent values use
36+
`Date.now() - offset` so a fresh clone produces a stable run.
37+
- Voice rules for any user-visible copy: short sentences, plain words,
38+
no em dashes, no marketing words. The `web/CLAUDE.md`-style banned
39+
list applies to documentation as much as code.
40+
41+
## Pull request expectations
42+
43+
- One change, one PR.
44+
- Tests if the change is testable. The capstone build accepts manual
45+
reproducibility steps in the PR description for now.
46+
- A short note in `CHANGELOG.md` under an Unreleased heading.
47+
- CI must pass: typecheck, lint, build, security scan.
48+
49+
## Security
50+
51+
If you find a vulnerability, please email contact@dmj.one before opening
52+
a public issue. See `docs/SECURITY.md` for the full disclosure policy.
53+
54+
## License
55+
56+
By contributing you agree that your contribution is licensed under the
57+
MIT license, the same as the rest of the project.

0 commit comments

Comments
 (0)