socketry-project 0.2.0

Shared project conventions and development tasks for Socketry Rust crates
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# `socketry-project`

Shared conventions and development tasks for Rust projects in the Socketry
organization.

## Motivation

Rust projects should share a small set of clear conventions and a reliable
release process without repeating task wiring in every repository.

## Usage

Add `socketry-project` to the dependencies of your private `bake/` package:

```toml
# bake/Cargo.toml
[dependencies]
bake = "0.17"
socketry-project = "0.2"
```

Link the tasks from `bake/src/main.rs`:

```rust,ignore
use bake::{Registry, Result};
use socketry_project as _;

fn main() -> Result<()> {
    Registry::discover()?.run()
}
```

This adds the standard Cargo, release, license, Readme, agent-context, and
testing tasks, including `test` and `test:external`. It also registers a
version-bump hook that updates the project's standard files.

See the [project setup guide](context/project-setup.md) for the minimal Cargo
configuration and the [project conventions](context/project-conventions.md) for
repository layout, documentation, and code conventions. The
[Rust Project Layout](context/project-layout.md) and
[GitHub Repository Setup](context/github-repository.md) guides provide more
detail. The [Rust Testing](context/testing.md) guide describes the standard
test workflow and optional downstream compatibility workflow.

### Agent Context

Install Bake once, then install all context documents provided by the resolved
Cargo dependencies:

```sh
cargo install socketry-cargo-bake --locked
cargo bake agent:context:install
```

The command copies every dependency's `context/` guides into
`.agents/context/` and updates `agents.md` with links to those guides. Read
`agents.md`, then open the relevant context files before continuing work. This
crate provides Socketry project guidance, while its Bake dependencies provide
focused guidance for Cargo publishing, licenses, Readmes, releases, and agent
context. The no-argument install command discovers context from all resolved
dependency crates used by the workspace.

The generated `.agents/context/` directory is ignored by Git and can be
refreshed by running the install task again after dependency updates. To install
only this crate's guides, use
`cargo bake agent:context:install --package socketry-project`.

See [Agent Context](context/agent-context.md) for guidance on writing and
organizing context for a project.

## Releasing

Prepare a release with `cargo bake cargo:version:patch` (or `minor`, `major`,
or `bump --version X.Y.Z`), then run `cargo bake cargo:release` and open a
pull request. After review and merge, GitHub Actions publishes the release
when the configured `crates-io` environment approves it. See the
[Cargo publishing guide](https://github.com/socketry/bake-cargo-rust/blob/main/context/publishing.md).

## Releases

<!-- bake-readme:releases:start -->
See [releases.md](releases.md) for the full release history.

### v0.2.0

- Move the shared project tasks to `bake` 0.17 and include standard Rust test tasks.
- Document standard local, downstream, and publishing workflows.

### v0.1.1

- Add a reusable Pull Requests guide to the packaged agent context.

### v0.1.0

- Establish shared conventions and standard Bake tasks for Socketry Rust projects.
- Document project layout, GitHub setup, and agent context installation.
<!-- bake-readme:releases:end -->

## See Also

- [socketry-project](https://github.com/socketry/socketry-project-rust) — Shared project conventions and development tasks for Socketry Rust crates <!-- bake-readme:package -->

## Contributing

Please open an issue or pull request on [GitHub](https://github.com/socketry/socketry-project-rust).