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
8 changes: 4 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
- **Clarity over cleverness.** Be concise, but favour explicit over terse or
obscure idioms. Prefer code that's easy to follow.
- **Use functions and composition.** Avoid repetition by extracting reusable
logic. Prefer generators or comprehensions, and declarative code to imperative
repetition when readable.
logic. Prefer generators or comprehensions, and declarative code to
imperative repetition when readable.
- **Small, meaningful functions.** Functions must be small, clear in purpose,
single responsibility, and obey command/query segregation.
- **Clear commit messages.** Commit messages should be descriptive, explaining
Expand Down Expand Up @@ -95,8 +95,8 @@
## Rust Specific Guidance

This repository is written in Rust and uses Cargo for building and dependency
management. Contributors should follow these best practices when working on
the project:
management. Contributors should follow these best practices when working on the
project:

- Run `make fmt`, `make lint`, and `make test` before committing. These targets
wrap `cargo fmt`, `cargo clippy`, and `cargo test` with the appropriate flags.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
uniform width. It can wrap paragraphs and list items to 80 columns when the
`--wrap` option is used. Hyphenated words are treated as single units during
wrapping, so `very-long-word` moves to the next line rather than splitting at
the hyphen. The tool ignores fenced code blocks and respects escaped pipes (`\|
`), making it safe for mixed content.
the hyphen. The tool ignores fenced code blocks and respects escaped pipes
(`\|`), making it safe for mixed content.

## Installation

Expand Down
16 changes: 8 additions & 8 deletions docs/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ workflow run while other targets build.

## Workflow details

The `release.yml` workflow defines a matrix of operating system and architecture
combinations. Each entry includes the target triple used by `cross` and a
filename extension for Windows. During the build job, `cross` compiles a release
binary for every matrix row.
The `release.yml` workflow defines a matrix of operating system and
architecture combinations. Each entry includes the target triple used by
`cross` and a filename extension for Windows. During the build job, `cross`
compiles a release binary for every matrix row.

`cross` is installed from a specific git tag to avoid unexpected behavior from
its main branch. Each binary is placed in an `artifacts/<os>-<arch>` directory
using the naming pattern `mdtablefix-<os>-<arch>[.exe]`. A SHA-256 checksum is
written alongside each binary for download verification.

After every build completes, the artifact is uploaded so that the GitHub Actions
interface provides it immediately. Once the matrix has finished, the `release`
job downloads all artifacts and uploads them to the GitHub release using
`gh release upload`.
After every build completes, the artifact is uploaded so that the GitHub
Actions interface provides it immediately. Once the matrix has finished, the
`release` job downloads all artifacts and uploads them to the GitHub release
using `gh release upload`.
Loading