idioms.md is a Steelbore-authored distillation (GPL-3.0-or-later) of
rules adapted from the Apollo GraphQL Rust Best Practices skill. Per the
Steelbore Standard §4.2 (upstream license compliance) and §15.3 (third-party
attribution), the upstream MIT notice is preserved verbatim below.
- Adapted work: Apollo GraphQL — Rust Best Practices skill (
rust-best-practices) - Source: https://github.com/apollographql/skills
- Upstream license: MIT
- What was adapted: the idiom/readability rules — borrowing-vs-cloning,
Copysizing, idiomaticOption/Resultflow, iterators-vs-for, clippy lint names andexpect-over-allowdiscipline, testing conventions (one assertion per test, descriptive names,instasnapshots), static-vs-dynamic dispatch, the type-state pattern, comments-vs-docs, import ordering, flamegraph profiling details (adapted from Chapter 3), and smart pointers / thread-safety guidelines (adapted from Chapter 9). Apollo's error-handling chapter was intentionally not adapted (covered by this skill's SKILL.md and bymicrosoft-rust-guidelines).
Note: the skill we adapted from (the
apollographql/skillsrepository) is MIT. A separate upstream repository — the standalone Rust Best Practices handbook/book — is Apache-2.0; we did not copy that book's text, only adapted the MIT skill, so the applicable notice is the MIT one below.
MIT License
Copyright (c) 2024 Apollo Graph, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.