XTasks

Essential tools and tasks for Rust projects using the xtask pattern, simplifying common build and development workflows.

• Website • Documentation • Report Bug • Request Feature • Contributing Guidelines

Overview

XTasks is a comprehensive Rust library designed to facilitate common operations and tasks in projects that adhere to the xtask pattern. This pattern is prevalent in the Rust ecosystem, where it is used to define custom build, test, and deployment scripts within a project’s workspace.

Table of Contents

• XTasks
  • Overview
  • Table of Contents
  • Getting Started
    • Prerequisites
    • Installation
  • Usage
  • Running the Tests
  • Semantic Versioning Policy
  • License
  • Contribution
  • Acknowledgements

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need Rust and Cargo installed on your system. If you don't have them installed, you can install them from the official Rust website.

Installation

To use XTasks, add it as a dependency to your Cargo.toml file:

[dependencies]
xtasks = "0.0.1"

Then, in your lib.rs or main.rs file, add:

extern crate xtasks;

Usage

You can use XTasks to simplify and standardize the process of building, testing, and deploying your Rust projects. For more detailed usage examples, please refer to the library's documentation.

Running the Tests

To run the tests, use the following command:

cargo test

Semantic Versioning Policy

For transparency into our release cycle and in striving to maintain backward compatibility, XTasks follows semantic versioning.

License

The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).

• Apache License, Version 2.0
• MIT license

Contribution

We welcome all people who want to contribute. Please see the contributing instructions for more information.

Contributions in any form (issues, pull requests, etc.) to this project must adhere to the Rust's Code of Conduct.

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.

Acknowledgements

A big thank you to all the awesome contributors of xtasks for their help and support.

A special thank you goes to the Rust Reddit community for providing a lot of useful suggestions on how to improve this project.