Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Improve Cargo.toml #203

Merged
merged 12 commits into from
Jan 2, 2025
Merged

chore: Improve Cargo.toml #203

merged 12 commits into from
Jan 2, 2025

Conversation

kurosakishigure
Copy link
Owner

@kurosakishigure kurosakishigure commented Jan 1, 2025

Description

  • What is the purpose of this PR?
    • Add more descriptive fields
    • Use cargo-msav to determine the minimum Rust version (we might need to open a new PR to add the corresponding workflows)
    • Use the `![NOTE]` tag
    • Improve the USE.md documentation
    • Add installation instructions for the canary version
    • Improve the include field
    • Add Crates.io badge to README.md
  • What problem does it solve?
    Screenshot 2025-01-02 at 4 34 11 AM
    • The extra files were mistakenly uploaded (details are provided in the README.md file, as we aim to save users’ disk space whenever possible)
    • Some values in the include field are redundant
  • Are there any breaking changes or backwards compatibility issues?

Related Issue

Type of Change

  • Miscellaneous tasks
  • Documentation update

How Has This Been Tested?

Run the following command to view the final files:

cargo package --list
Screenshot 2025-01-02 at 5 25 31 AM

Checklist

  • I have read and followed the guidelines in CONTRIBUTING.md
  • I have already updated the related templates accordingly (if applicable)
  • I have written or updated relevant documentation (if applicable)
  • I have added or updated tests to cover my changes (if applicable)
  • I have reviewed my code for any potential issues

Additional Notes

@github-actions github-actions bot added the chore Miscellaneous tasks(PR) label Jan 1, 2025
@kurosakishigure kurosakishigure changed the title chore: Improve the include section in the Cargo.toml file chore: Improve the include section in the Cargo.toml file Jan 1, 2025
@kurosakishigure kurosakishigure changed the title chore: Improve the include section in the Cargo.toml file chore: Improve the include field in the Cargo.toml file Jan 1, 2025
@kurosakishigure kurosakishigure changed the title chore: Improve the include field in the Cargo.toml file chore: Improve the include field in the Cargo.toml file Jan 1, 2025
@kurosakishigure kurosakishigure force-pushed the chore/improve_cargo_toml branch from 0d1de9e to b917718 Compare January 1, 2025 21:18
@kurosakishigure
Copy link
Owner Author

I used git push --force to update my commit message because I changed the title of the PR.

@kurosakishigure kurosakishigure marked this pull request as draft January 1, 2025 23:05
@kurosakishigure kurosakishigure changed the title chore: Improve the include field in the Cargo.toml file chore: Improve Cargo.toml and USE.md Jan 1, 2025
@kurosakishigure kurosakishigure changed the title chore: Improve Cargo.toml and USE.md chore: Improve Cargo.toml Jan 1, 2025
@kurosakishigure kurosakishigure changed the title chore: Improve Cargo.toml chore: Improve Cargo.toml and USE.md Jan 1, 2025
@kurosakishigure kurosakishigure marked this pull request as ready for review January 2, 2025 00:00
@kurosakishigure kurosakishigure marked this pull request as draft January 2, 2025 00:05
@kurosakishigure kurosakishigure changed the title chore: Improve Cargo.toml and USE.md chore: Improve Cargo.toml Jan 2, 2025
@kurosakishigure kurosakishigure marked this pull request as ready for review January 2, 2025 11:05
@kurosakishigure kurosakishigure merged commit c043535 into canary Jan 2, 2025
15 checks passed
@kurosakishigure kurosakishigure deleted the chore/improve_cargo_toml branch January 2, 2025 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Miscellaneous tasks(PR)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant