chore: open-source community health files#43
Merged
Conversation
Sets up the standard set of community-facing docs and templates so the project is set up for outside contributors: - CODE_OF_CONDUCT.md — adopts Contributor Covenant 2.1 by reference; contact: thraen@gmail.com - CONTRIBUTING.md — build/test, --clean flag for safe lifecycle testing, branch + commit naming, PR expectations, label conventions - SECURITY.md — supported versions table, private reporting via GitHub Security Advisories or thraen@gmail.com, scope notes for the local desktop attack surface - ISSUE_TEMPLATE/bug_report.yml — form with version/OS/dotnet fields and a crash.log excerpt prompt; auto-labels 'bug' - ISSUE_TEMPLATE/feature_request.yml — problem/solution/alternatives form; auto-labels 'enhancement' - ISSUE_TEMPLATE/config.yml — disables blank issues, points questions to Discussions and security to the advisory channel - PULL_REQUEST_TEMPLATE.md — Summary / Why / Implementation notes / Test plan checklist / Screenshots, matching the pattern in recent merged PRs - SUPPORT.md — short index of where to ask what - dependabot.yml — weekly nuget + github-actions, grouped per ecosystem, capped at 5 open PRs
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
Sets up the standard set of community-facing docs and templates so CSM is well-positioned for outside contributors and shows a complete community-health checklist on GitHub.
Why
Currently the repo has README + LICENSE + CI but no contributing guide, no code of conduct, no security policy, no issue templates, no PR template, no Dependabot. Anyone landing on the repo has to guess at the contribution process, and there's no private channel for security reports.
What's added
.github/CODE_OF_CONDUCT.mdthraen@gmail.com..github/CONTRIBUTING.md--cleanflag for safe lifecycle testing, branch + commit naming derived from the existinggit log, PR expectations, label conventions, code-style notes pointing to CLAUDE.md..github/SECURITY.mdthraen@gmail.com, scope notes for the local desktop surface..github/ISSUE_TEMPLATE/bug_report.ymlcrash.logfields. Auto-labelsbug..github/ISSUE_TEMPLATE/feature_request.ymlenhancement..github/ISSUE_TEMPLATE/config.yml.github/PULL_REQUEST_TEMPLATE.md.github/SUPPORT.md.github/dependabot.ymlImplementation notes
CODE_OF_CONDUCT.mdthat points to the canonical Contributor Covenant URL and shows the community-health checkmark.bugandenhancement, which already exist; Dependabot'sdependenciesis auto-applied.package.json(xterm.js assets are vendored underAssets/).Test plan
New issuepage presents the two forms (Bug / Feature) plus the Discussions / Security advisory contact links, with no blank-issue optionNew pull requestpopulates the body with the PR template