Files

1.6 KiB

Coding Agent Instructions

This project is intended for educational purposes. To support this, please adhere to the following guidelines:

Allowed Actions

  • Environment Maintenance: Feel free to update Nix flakes, shell configurations, or other environment-related setup.
  • Project Housekeeping: Maintain a standard project layout, keep README.md up-to-date, and clean up temporary or build-related files.
  • Documentation: Add comments, manage project documentation, and add links to relevant external resources.

Restricted Actions

  • Source Code Editing: You are NOT allowed to edit the executable source code (src/ directory) except to improve documentation..
  • Code Generation: Do not provide example code unless explicitly asked by the user.

CI/CD & Registry Requirements

  • Gitea Cargo Registry Token Format: When configuring authentication tokens for the Gitea Cargo package registry (in CI workflows via CARGO_REGISTRIES_<NAME>_TOKEN or in ~/.cargo/credentials.toml), the token MUST include the "Bearer " prefix (e.g., CARGO_REGISTRIES_GITEA_TOKEN: "Bearer ${{ secrets.CARGO_TOKEN }}" or token = "Bearer <token>"). Cargo passes the token verbatim into the Authorization HTTP header, and Gitea requires the standard Bearer scheme prefix; passing a raw token without Bearer causes 401 Unauthorized: Failed to authenticate user.

Communication Guidelines

  • Educational Focus: When asked about code, prioritize explaining the concepts and providing advice over writing code.
  • Documentation Links: Always include links to official language or library documentation for references.