From 6bdb4a384beaac7f8a3151cf4c111147bad19f7a Mon Sep 17 00:00:00 2001 From: markmybytes Date: Fri, 30 Oct 2026 23:35:23 +0800 Subject: [PATCH] docs: audit root doc set, add CONTRIBUTING CONTRIBUTING.md was missing entirely; AGENTS.md CI section still pointed at the removed test.yml workflow (renamed to ci.yml in #75) and lacked a doc map. README.md had a broken execution-option anchor and assorted typos. --- AGENTS.md | 11 ++++++++++- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ README.md | 12 ++++++------ 3 files changed, 51 insertions(+), 7 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/AGENTS.md b/AGENTS.md index f75de1f..df48e33 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -77,5 +77,14 @@ cd frontend && npm run type-check ## CI -- **Test workflow** (`.github/workflows/test.yml`): Runs on PRs to `main`. Executes `go test ./pkg/...` on Windows. +- **Test workflow** (`.github/workflows/ci.yml`): Runs on PRs and pushes to `main` — Go checks (Windows) and frontend checks (lint, format, type-check, tests). See the workflow file for the exact commands. - **Release workflow** (`.github/workflows/build_and_release.yml`): Triggered by `v*` tags. Builds x86 + x64 Windows binaries with UPX compression, bundles WebView2 runtime, builds Python updater from separate repo, drafts GitHub release. + +## Related Docs + +| Document | Owns | +|---|---| +| [README.md](README.md) | Project overview, setup, and usage for humans | +| [CONTRIBUTING.md](CONTRIBUTING.md) | Contribution workflow: branches, commits, PRs | +| [STYLE.md](STYLE.md) | Coding conventions (detailed Vue/TS + Go rules) | +| AGENTS.md | Agent-facing commands, architecture, constraints (this file) | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ffb0cad --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing + +See [README.md](README.md) for setup and development commands. + +## Before You Start + +- Check existing issues and pull requests before opening a new one. +- Discuss substantial feature changes before implementation. +- Branch from the repository's default branch. + +## Branches and Commits + +Use a descriptive branch name. Keep each branch focused on one concern. + +Use [Conventional Commits](https://www.conventionalcommits.org/): + +```text +(): +``` + +Common types: `feat`, `fix`, `docs`, `chore`, `refactor`, `test`, `ci`, and `perf`. Use `!` or a `BREAKING CHANGE:` footer for breaking changes. + +## Pull Requests + +- Keep one concern per pull request. +- Explain what changed, why, and any important design decisions. +- Add or update tests for behavior changes and bug fixes. +- Update documentation when behavior, commands, or public interfaces change. +- Run the verification commands from [README.md](README.md) and follow [STYLE.md](STYLE.md) before pushing. +- Address review feedback before merge. + +## Issues + +- [Report a bug](https://github.com/markmybytes/install-it/issues/new?labels=bug&template=bug-report---.md) — include versions, environment details, and a minimal reproduction. +- [Request a feature](https://github.com/markmybytes/install-it/issues/new?labels=enhancement&template=feature-request---.md) — describe the problem, not just the solution. diff --git a/README.md b/README.md index d1d246b..4df986d 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@

- English + English · 繁體中文

@@ -122,26 +122,26 @@ To add an installer into install-it: 1. Place all your installer under the `driver/` folder 2. Create a installer group - you can add multiple installer into a single group - - install-it predefined three categroies: `network`, `display`, and `miscellaneous`, only `miscellaneous` allow multiple selection + - install-it predefined three categories: `network`, `display`, and `miscellaneous`, only `miscellaneous` allow multiple selection 3. Enter the details for each installer 4. Done > [!TIP] > It is highly recommended to provide the correct command-line options so that the installer can be executed in unattended mode to maximise functionality of install-it.
-> See [Exection Option](#exection-option) section for more information. +> See [Execution Option](#execution-option) section for more information.
[Example] Execute commands You can execute binary available in the OS `PATH` variable. In Windows, you can use CMD or Powershell to execute commands or scripts. - For CMD, you can execute commands by entering `cmd` in the path field, and `/c,` in the option field. Then it is equivlent to: + For CMD, you can execute commands by entering `cmd` in the path field, and `/c,` in the option field. Then it is equivalent to: ```batch cmd /c command ``` - For Powershell, you can execute commands by entering `powershell` in the path field, and `-Command,` in the option field. Then it is equivlent to: + For Powershell, you can execute commands by entering `powershell` in the path field, and `-Command,` in the option field. Then it is equivalent to: ```batch powershell -Command command @@ -151,7 +151,7 @@ To add an installer into install-it:
[Example] Install non-driver software - Software installer usually provides a slient install options like driver installers. For example, Steam support silent install by supplying `/S` option when you executing `SteamSetup.exe`. Explore yourself and turn install-it to your PC setup toolbox :) + Software installer usually provides a silent install options like driver installers. For example, Steam support silent install by supplying `/S` option when you executing `SteamSetup.exe`. Explore yourself and turn install-it to your PC setup toolbox :)
### Execution Option