Add open-source project scaffolding: contributor docs, issue/PR templates, and lint CI - #269
Open
Kantosaurus wants to merge 5 commits into
Open
Add open-source project scaffolding: contributor docs, issue/PR templates, and lint CI#269Kantosaurus wants to merge 5 commits into
Kantosaurus wants to merge 5 commits into
Conversation
…pport docs Add the standard community-health files under .github/: CONTRIBUTING.md (development setup for the bare-repo workflow, shell/Python conventions, how to add a setup subscript), CODE_OF_CONDUCT.md (Contributor Covenant 2.1), SECURITY.md (vulnerability reporting policy), and SUPPORT.md (where to get help).
Structured bug-report and feature-request forms that capture GPU vendor, filesystem, and install method (the fields most issues hinge on), a PR template, an issue-template chooser pointing at Discord and the included docs, and a Dependabot config for GitHub Actions.
- .github/workflows/lint.yml: check shell syntax (bash -n), Python syntax (py_compile), and CRLF line endings on every push and pull request - .gitattributes: pin all text files to LF so a contributor with core.autocrlf=true cannot commit a script that fails on Arch with /usr/bin/env: 'bash\r' - .editorconfig: match the existing 4-space convention - .gitignore: ignore the graphify-out/ tooling output - renormalize two tracked text files that had CRLF endings
Rewrite the README with a structured landing (badges, table of contents, clearer install steps, grouped feature overview, contributing section) while preserving all existing content, and correct a few stale script paths and the cheatsheet keybind. Add CHANGELOG.md.
A conditional block was closed with } instead of fi, so the script failed to parse and could not run. Replace the } with fi.
Owner
|
What model was used for all this? |
Contributor
Author
|
Claude opus 5.0 |
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
Dusky ships MIT + README +
.gitignoreand nothing else in the way of project infrastructure. This PR adds the standard open-source scaffolding a project of this size benefits from — contributor docs, issue/PR templates, CI, and line-ending enforcement — plus a small script bugfix found along the way. No behavioural changes to the desktop; this is repository health only.What this adds
Community health (
.github/)CONTRIBUTING.md— development setup for the bare-repo deployment model (how to edit safely without scattering files into$HOME), shell and Python conventions matched to the existing tree, and how to add a setup subscript.CODE_OF_CONDUCT.md— Contributor Covenant 2.1.SECURITY.md— a vulnerability-reporting policy, plus the things a user should understand before installing (privileged install scripts, networking helpers, the wireless tooling).SUPPORT.md— routes questions to Discord and the included docs.Issue / PR flow
CI + consistency
lint.yml— checks shell syntax (bash -n), Python syntax (py_compile), and CRLF line endings on every push and pull request..gitattributes— pins all text files to LF. This is load-bearing: Dusky deploys withgit checkout -finto$HOME, and a script that lands with CRLF fails at exec time on Arch with/usr/bin/env: 'bash\r': No such file or directory. Two tracked text files that had CRLF endings are renormalized (the large line counts in those two files are line-ending-only changes)..editorconfig— matches the existing 4-space convention.Docs
CHANGELOG.mdseeded from the recent history.Bugfix
dusky_tui_4.3.0.shhad a conditional block closed with}instead offi, so the script failed to parse and could not run. Corrected.Verification
The
lintworkflow passes on this branch:bash -nis clean across all shell scripts (thedusky_tuifix is what makes it 0 failures),py_compileis clean across all Python, no tracked file has CRLF, and all added YAML validates.Notes
SECURITY.mdhere is the standard "how to report a vulnerability" policy; it is generic and does not describe any specific issue.