Creating A New Rust Crate
This document contains a set of templates and content that I use by convention in many of the Rust projects I’ve worked on. This list functions as a checklist that can be referenced when creating a new Rust crate and associated source repository, ensuring projects have a consistent level of quality and polish. If these conventions are useful to you, feel free to follow or adapt them in your projects.
README.md
Header Section
Every crate repository should have a header with status ‘shields’ for the latest crates.io release, the crate license, and an indicator of the documentation status. Additionally, there should be a ‘quick links’ bar with links to the online API documentation, CHANGELOG.md, and instructions for contributing to the repository.
The screenshot below illustrates what this standard header content looks like:
Status Shields
[](https://crates.io/crates/CRATE-NAME)  [](https://docs.rs/CRATE-NAME)
Quick Links
Variant A (Markdown):
#### [API Documentation](https://docs.rs/CRATE-NAME) | [Changelog](./docs/CHANGELOG.md) | [Contributing](./docs/CONTRIBUTING.md)
Variant B (Markdown, Contributing is anchor link):
#### [API Documentation](https://docs.rs/CRATE-NAME) | [Changelog](./docs/CHANGELOG.md) | [Contributing](#contributing)
Variant C (HTML; works in .md files too):
<h4> <a href="https://docs.rs/CRATE-NAME">API Documentation</a> <span> | </span> <a href="https://github.com/OWNER/REPO/blob/master/docs/CHANGELOG.md">Changelog</a> <span> | </span> <a href="https://github.com/OWNER/REPO/blob/master/docs/CONTRIBUTING.md">Contributing</a> </h4>
License Section
Note: This content assumes that you have added the LICENSE-APACHE and LICENSE-MIT files to the repository.
## License Licensed under either of * Apache License, Version 2.0 ([LICENSE-APACHE](./LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>) * MIT license ([LICENSE-MIT](./LICENSE-MIT) or <http://opensource.org/licenses/MIT>) at your option.
Contributing Section
## Contributing Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. <!-- If applicable: --> <!-- See [CONTRIBUTING.md](./docs/CONTRIBUTING.md) for more information. --> <!-- See [**Development.md**](./docs/Development.md) for instructions on how to perform common development tasks when contributing to this project. --> <!-- See [*Maintenance.md*](./docs/Maintenance.md) for instructions on how to maintain this project. -->
Test README.md examples
It is common for Rust repository README.md files to include bits of example code to give potential users a taste of what the library has to offer. However, one disadvantage of putting examples in README.md files is that they are not automatically tested like code examples in Rust documentation comments. This makes it easy for code examples in README.md to get out of date.
Placing the following code in your crate’s lib.rs file will cause code examples in README.md to get tested just like normal documentation examples, ensuring they are always up-to-date:
/// Ensure that doc tests in the README.md file get run. /// See: <https://connorgray.com/reference/creating-a-new-rust-crate#test-readmemd-examples> // Note: // This cfg is needed only if `include_str!` points outside the crate's directory, // to prevent this file from not being available during `$ cargo publish`. #[cfg(any(doc, doctest))] #[doc(hidden)] mod test_readme { #![doc = include_str!("../README.md")] }
Project Documentation
docs/Development.md
Template for Development.md:
# Development This document contains information useful to anyone wishing to contribute to the development of this project. ## Quick Command Reference **Build the library:** ```shell $ cargo build ``` **Run the tests:** ```shell $ cargo test ```
docs/Maintenance.md
Template for Maintenance.md:
# Maintenance This document describes steps required to maintain the [[CRATE-NAME]] project. This document is informational and intended for the maintainer of this project; users of this project do not need to read this document.
docs/CHANGELOG.md
This document should follow the Keep a Changelog format.
# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [0.0.2] - YYYY-MM-DD ### Added - Added something ([#2]) ### Changed - Fixed something ([#3]) ## [0.0.1] - YYYY-MM-DD Initial release. ### Added - Added all initial functionality ([#1]) <!-- v0.0.1 --> [#1]: https://github.com/OWNER/REPO/pull/1 <!-- v0.0.2 --> [#2]: https://github.com/OWNER/REPO/pull/2 [#3]: https://github.com/OWNER/REPO/pull/3 <!-- This needs to be updated for each tagged release. --> [Unreleased]: https://github.com/OWNER/REPO/compare/v0.0.2...HEAD [0.0.2]: https://github.com/OWNER/REPO/compare/v0.0.1...v0.0.2 [0.0.1]: https://github.com/OWNER/REPO/releases/tag/v0.0.1
I’ve extended the Keep a Changelog format with the basic convention that each change should list the pull request associated with it, if possible.
One subtle aspect of this structure is that the [#X] pull-request list grows downwards, while the [X.X.X] reference links list grows upwards, so that both lists grow to meet at the [Unreleased] reference link. This limits the scrolling that is required to add new links when updating CHANGELOG.md, and generally means that all the links that need to be updated will fit on the screen at once.
Scrolling is a context switch, so not having to scroll as much reduces the likelihood of mistakes when updating links.
Cargo.toml
A sample Cargo.toml:
[package] name = "TheCrate" version = "X.X.X" authors = ["Connor Gray <code@connorgray.com>"] edition = "2021" license = "MIT OR Apache-2.0" readme = "README.md" repository = "https://github.com/OWNER/REPO" description = "Efficient and ergonomic XXXXX" keywords = ["wolfram", "wolfram-language", "mathematica", "expression"] categories = ["XXXX"]
rustfmt.toml
My standard rustfmt.toml content:
max_width = 80 match_block_trailing_comma = true blank_lines_upper_bound = 2 merge_derives = false # Allows separating std derives from third-party crate derives overflow_delimited_expr = true
Adding License Files
LICENSE-MIT content
MIT License Copyright (c) 2022 [Connor Gray | Wolfram Research 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.
LICENSE-APACHE content
The Apache license does not have an embedded copyright year or copyright holder name, so no modification to the license text is required.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS