docs: add OSS project docs, CI, and release automation#8
Merged
Conversation
- Rewrite README with badges, features, install, build, and usage - Add CI workflow (go vet/test + frontend build) on push/PR - Add cross-platform release workflow (macOS/Windows/Linux) on v* tags - Add CONTRIBUTING (incl. SemVer release process), CODE_OF_CONDUCT, SECURITY, CHANGELOG, issue forms, and PR template - Update screenshot to the redesigned UI; ignore OS/editor cruft
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
1 participant
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.
Makes the repo read as a properly maintained open-source project.
What's included
.github/workflows/ci.yml) —go vet+go test -raceand the frontend build (incl.tsc) on every push/PR..github/workflows/release.yml) — on av*tag, builds macOS (universal), Windows, and Linux artifacts via the Wails build action and publishes a GitHub Release with auto-generated notes. Pre-release suffixes (e.g.-rc.1) are flagged automatically.CONTRIBUTING.md(with a SemVer release process),CODE_OF_CONDUCT.md,SECURITY.md,CHANGELOG.md(Keep a Changelog), issue forms, and a PR template..gitignorenow covers OS/editor cruft; replaced the old screenshot.Release cycle
SemVer, cut from
main: moveUnreleased→ a versioned section, tagvX.Y.Z, push the tag → the release workflow builds and publishes binaries. SeeCONTRIBUTING.md#releasing.Notes
main; the first real release (suggestedv0.1.0) should be tagged after merge.