Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
<type>(<scope>): <description>
```

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.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</p>

<p align="center">
<a href="https://github.com/markmybytes/install-it//README.md">English</a>
<a href="https://github.com/markmybytes/install-it">English</a>
·
<a href="https://github.com/markmybytes/install-it/readme/README.zh_Hant.md">繁體中文</a>
</p>
Expand Down Expand Up @@ -122,26 +122,26 @@ To add an installer into install-it:
1. Place all your installer under the `driver/<category>` 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. <br />
> See [Exection Option](#exection-option) section for more information.
> See [Execution Option](#execution-option) section for more information.

<details>
<summary>[Example] Execute commands</summary>

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,<command>` in the option field. Then it is equivlent to:
For CMD, you can execute commands by entering `cmd` in the path field, and `/c,<command>` 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,<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,<command>` in the option field. Then it is equivalent to:

```batch
powershell -Command command
Expand All @@ -151,7 +151,7 @@ To add an installer into install-it:
<details>
<summary>[Example] Install non-driver software</summary>

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 :)
</details>

### Execution Option
Expand Down
Loading