From b2212181ed6b01b483ec0c2f7e33b6b11b2e1800 Mon Sep 17 00:00:00 2001 From: Marie Date: Sun, 7 Jun 2026 04:15:50 +0000 Subject: [PATCH] docs(org): add Cognivanta engineering baseline --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 27 +++++++++++++++++++ PULL_REQUEST_TEMPLATE.md | 22 ++++++++++++++++ README.md | 5 ++++ docs/engineering-baseline.md | 20 ++++++++++++++ 5 files changed, 106 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 PULL_REQUEST_TEMPLATE.md create mode 100644 docs/engineering-baseline.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..3e92ee6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Report a defect in a Cognivanta repository +title: "[bug]: " +labels: ["bug"] +--- + +## Summary + +What happened? + +## Impact + +What is broken and who is affected? + +## Steps to reproduce + +1. +2. +3. + +## Expected behavior + +## Actual behavior + +## Evidence + +Logs, screenshots, error messages, or links. + +## Environment + +Repo, branch, commit, and runtime context. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5739fc2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Feature request +about: Suggest a small improvement or product change +title: "[feat]: " +labels: ["enhancement"] +--- + +## Problem + +What problem are we solving? + +## Proposed change + +What should change? + +## Business value + +Why does this matter? + +## Acceptance criteria + +- [ ] +- [ ] + +## Notes + +Anything else the team should know. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..41b23bd --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +## Summary + +What changed? + +## Why + +Why is this needed? + +## Validation + +What did you check? + +## Risk + +What could go wrong? + +## Checklist + +- [ ] Scope is minimal +- [ ] No secrets were added or changed +- [ ] No production settings were changed +- [ ] Documentation was updated when needed diff --git a/README.md b/README.md index d3a47aa..00577ee 100644 --- a/README.md +++ b/README.md @@ -124,3 +124,8 @@ The goal is not technology for its own sake, but the creation of practical syste ## Focus Operational Intelligence • AI-Assisted Automation • Telecom Operations • Observability • Workflow Orchestration • Infrastructure Automation • Autonomous Systems • Reliability • Analytics • Execution Systems + + +## Engineering baseline + +- [Cognivanta engineering baseline](docs/engineering-baseline.md) diff --git a/docs/engineering-baseline.md b/docs/engineering-baseline.md new file mode 100644 index 0000000..ba514c9 --- /dev/null +++ b/docs/engineering-baseline.md @@ -0,0 +1,20 @@ +# Cognivanta Engineering Baseline + +Use this baseline for small, repeatable improvements across Cognivanta repositories. + +## Minimum standard + +- Every product repo should have a clear README. +- Changes should go through a pull request, preferably draft until ready. +- Add issue templates when the repo receives operational or product work. +- Add a minimal CI check for active code repos. +- Keep deployment instructions close to the code. +- Avoid new dependencies unless they reduce risk or manual work. + +## Review rules + +- No secrets in code, docs, or workflow files. +- No production changes without explicit intent. +- Prefer the smallest change that improves clarity or reliability. +- Document the validation command when a repo has one. +- Keep workflows simple and readable.