chore: add GitHub community kit, templates and CHANGELOG - #13
Open
abhinav-phi wants to merge 1 commit into
Open
Conversation
- SECURITY.md: private vulnerability disclosure policy scoped to the embedded API, artifact integrity and notebook code paths - CONTRIBUTING.md: _build sources → pack.py → smoke_test.py workflow, code standards (determinism, artifact contract, no silent coercion) - CODE_OF_CONDUCT.md: Contributor Covenant v2.1 - pull_request_template.md + issue templates (bug report, feature request, config.yml with Discussions/Security contact links) - CODEOWNERS, SUPPORT.md (docs index + troubleshooting), FUNDING.yml - CHANGELOG.md: Keep a Changelog format covering the 1.0.0 Colab Edition release and the pre-Colab local edition history
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the complete GitHub community kit — the standard open-source scaffolding (per the widely-used
project-templatelayout) tailored to The Sentinel NIDS — plus a CHANGELOG covering both the current Colab Edition and the pre-Colab local edition history.What's Included (12 files)
Governance & community
.github/SECURITY.md.github/CONTRIBUTING.md_build/*.pysources, never the.ipynb— plus the full workflow (pack.py→smoke_test.py), where-changes-go table, code standards (determinism, artifact contract, no silent coercion, graceful GPU fallback).github/CODE_OF_CONDUCT.md.github/SUPPORT.md.github/CODEOWNERS_build/anddocs/highlighted).github/FUNDING.ymlTemplates
.github/pull_request_template.mdpack.py+smoke_test.py), artifact-contract and determinism reminders, conventional-commit title rule.github/ISSUE_TEMPLATE/1-bug-report.md.github/ISSUE_TEMPLATE/4-feature-request.md.github/ISSUE_TEMPLATE/config.ymlAutomation & history
CHANGELOG.md[0.x]local-edition history.github/workflows/ci.yml(second commit — see note)Why
The repo previously had no contribution surface beyond the README. This kit makes the project look and behave like a properly-governed open-source project — safe disclosure, guided contributions, structured issues, and automated validation — which matters for a security-oriented portfolio project.
Note on the CI workflow
The stored OAuth credential lacks the
workflowscope, so.github/workflows/ci.ymlis committed locally on the same branch but could not be pushed by automation. Merging this PR first, then pushing the branch's second commit (git push origin chore/github-community-kitaftergit pull), or applying the identical file manually, enables CI. The file is ready-to-use as-is (working-directory–scoped steps, pip cache, 20-minute timeout).Testing
config.ymllink targets exist (/discussions,/security/advisories/new,/docs)*+ directory rules valid for a solo-maintained repo