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
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "socketry-project"
version = "0.3.8"
version = "0.3.9"
edition = "2024"
license = "MIT"
repository = "https://github.com/socketry/socketry-project-rust"
Expand Down
2 changes: 1 addition & 1 deletion bake/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ publish = false
[dependencies]
bake = "0.19.0"
bake-markdown = "0.3.0"
socketry-project = { path = "..", version = "0.3.8" }
socketry-project = { path = "..", version = "0.3.9" }
2 changes: 1 addition & 1 deletion context/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Keep public paths independent of redundant namespace layers such as `bake_agent_
## Source naming

- Use `snake_case` for modules, source files, functions, methods, and variables. Use `UpperCamelCase` for structs, enums, traits, and type parameters.
- Preserve established initialisms in type and trait names: write `HTMLRenderer`, `HTTPClient`, and `URLParser`, rather than `HtmlRenderer`, `HttpClient`, or `UrlParser`. Keep filenames lowercase `snake_case`, such as `html_renderer.rs`, `http_client.rs`, and `url_parser.rs`.
- Treat acronyms and initialisms as single words in `UpperCamelCase`, following the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/naming.html#casing-conforms-to-rfc-430-c-case): write `HtmlRenderer`, `HttpClient`, `UrlParser`, and `FileIo`. Use lowercase acronyms in `snake_case`, including filenames such as `html_renderer.rs`, `http_client.rs`, and `file_io.rs`. This keeps Socketry's Rust APIs consistent with the Rust ecosystem; names required by external APIs retain their original spelling.
- Make public type and trait names fully descriptive; include the kind of thing being named instead of relying on the module path to supply it. For example, use `io_stream::BufferedStream` rather than `io_stream::Buffered`.
- Prefer clear, consistent names. Avoid abbreviations unless they are an established domain initialism or required by an external API.
- Give each primary public struct, enum, or trait its own source file, named after the item using lowercase `snake_case`. Keep small, closely related helper types alongside it when that makes the code easier to understand.
Expand Down
10 changes: 4 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ Prepare a release with `cargo bake cargo:version:patch` (or `minor`, `major`, or

See [releases.md](releases.md) for the full release history.

### v0.3.9

- Follow Rust acronym casing in type and trait names, using `HtmlRenderer`, `HttpClient`, `UrlParser`, and `FileIo`.

### v0.3.8

- Let Cargo select setup dependency versions while retaining open-ended minimum requirements.
Expand All @@ -49,12 +53,6 @@ See [releases.md](releases.md) for the full release history.
- Require a stable aggregate test and coverage result alongside publishing checks.
- Clarify merge gates and repository-owned agent guidance in the shared conventions.

### v0.3.6

- Normalize standard project Markdown files after version bumps.
- Fix the version bump hook's invocation of the Markdown normalizer.
- Include `bake-markdown` 0.3.0 in the shared task set so version bumps use hyphen markers for unordered lists.

<!-- bake-readme:releases:end -->

## See Also
Expand Down
4 changes: 4 additions & 0 deletions releases.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Releases

## v0.3.9

- Follow Rust acronym casing in type and trait names, using `HtmlRenderer`, `HttpClient`, `UrlParser`, and `FileIo`.

## v0.3.8

- Let Cargo select setup dependency versions while retaining open-ended minimum requirements.
Expand Down
Loading