chore: ensure users are using correct version of rust toolchain

[maschad]

• Closes cargo install junkanoo fails #10

Summary by CodeRabbit

• New Features

  • Introduced a standardized GitHub issue template for submitting bug reports, making it easier to provide all necessary details.
  • Added a configuration file to enforce the use of Rust compiler version 1.87.0 and enable cross-compilation for multiple platforms.

• Documentation

  • Updated installation instructions to require and verify Rust version 1.87.0.
  • Improved formatting and clarity in package metadata.

[coderabbitai]

Walkthrough

A new GitHub issue template for bug reports was added, along with a rust-toolchain.toml file specifying Rust version 1.87.0 and supported targets. The Cargo.toml was updated to require Rust 1.87.0, and the README now instructs users to verify their Rust version before building.

Changes

File(s)	Change Summary
.github/ISSUE_TEMPLATE/bug_report.md	Added a structured GitHub issue template for bug reports with required fields and metadata.
rust-toolchain.toml	Introduced toolchain config specifying Rust 1.87.0, rustfmt, clippy, and cross-compilation targets.
Cargo.toml	Reformatted metadata and added rust-version = "1.87.0" to enforce minimum Rust version.
README.md	Updated installation steps to verify Rust 1.87.0 before building; renumbered steps accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant Maintainers

    User->>GitHub: Open new issue (bug report)
    GitHub->>User: Present bug_report.md template
    User->>GitHub: Fill and submit structured bug report
    GitHub->>Maintainers: Notify with standardized bug report

Loading

sequenceDiagram
    participant Developer
    participant rust-toolchain.toml
    participant Cargo

    Developer->>rust-toolchain.toml: Sync toolchain (Rust 1.87.0, rustfmt, clippy, targets)
    Developer->>Cargo: Build project
    Cargo->>Developer: Enforce rust-version = 1.87.0

Loading

Poem

🐇
A template for bugs, so clear and neat,
Rust version checks before you hit "repeat."
Toolchains aligned, targets in tow,
Building with confidence—off we go!
With every hop and every line,
Our code and reports now both align.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

.github/ISSUE_TEMPLATE/bug_report.md (1)

1-7: Use an explicit empty list for assignees
The YAML front matter uses assignees: '', which may be ambiguous. It's more idiomatic to specify an empty array:

- assignees: ''
+ assignees: []

README.md (1)

46-50: Prefer using rustc --version for clarity
Since elsewhere we ask for the output of rustc --version, replacing rustup show with:

rustc --version

directly confirms the active compiler version.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 881c5aa and 01f8c3f.

📒 Files selected for processing (4)

• .github/ISSUE_TEMPLATE/bug_report.md (1 hunks)
• Cargo.toml (1 hunks)
• README.md (1 hunks)
• rust-toolchain.toml (1 hunks)

🔇 Additional comments (5)

.github/ISSUE_TEMPLATE/bug_report.md (2)

8-106: Issue template fields look comprehensive
The structured body definitions cover all essential bug details (description, reproduction steps, environment, logs, etc.).

---

108-153: Verify duplication of static markdown section
The markdown after the front matter replicates the same fields defined in the form. Confirm if this redundancy is intentional or if the static section should be removed to avoid confusing users.

Cargo.toml (1)

2-10: Minimum Rust version declared correctly
Adding rust-version = "1.87.0" aligns the crate metadata with the pin in rust-toolchain.toml and README instructions.

README.md (1)

56-59: Install binary step is clear
The instructions for cargo install --path . are accurate and optional.

rust-toolchain.toml (1)

1-4: Toolchain configuration is aligned
Pinning the channel to 1.87.0 and including rustfmt, clippy, plus the specified targets ensures everyone builds with the correct setup.