44 lines
2.2 KiB
Plaintext
44 lines
2.2 KiB
Plaintext
---
|
|
description:
|
|
globs:
|
|
alwaysApply: true
|
|
---
|
|
# Gitea Usage Rules
|
|
|
|
## Purpose
|
|
Establish disciplined, transparent, and user-aligned protocols for using Gitea, especially regarding issue management and traceability between code and issues.
|
|
|
|
## Rules
|
|
|
|
1. **Stick to the Current Selected Issue**
|
|
- Always work with a clearly selected, active Gitea issue.
|
|
- All code changes must be associated with the currently selected issue.
|
|
- If you need to switch issues, document the switch and update the new issue context before proceeding.
|
|
|
|
2. **Update Issues After Commits**
|
|
- After every commit, update the relevant Gitea issue(s) with a summary of the changes made.
|
|
- Include references to commit hashes and affected files or features.
|
|
- If the commit resolves or partially addresses the issue, state this explicitly in the issue update.
|
|
|
|
3. **Link Commits in Issues**
|
|
- Every commit message must reference the relevant Gitea issue by its number (e.g., `Fixes #42` or `Refs #42`).
|
|
- When updating an issue, include direct links to the commit(s) in Gitea for traceability.
|
|
- Use Gitea's markdown syntax to create clickable links to commits and related issues.
|
|
|
|
4. **Issue-Driven Workflow**
|
|
- Do not make code changes without an associated issue.
|
|
- If a new task arises, create a Gitea issue before starting work.
|
|
- Use issues to track discussions, decisions, and progress.
|
|
|
|
5. **Responsibility for Issue Hygiene**
|
|
- Keep issue status, labels, and assignees up to date.
|
|
- Close issues only when fully resolved and after confirming with all stakeholders if needed.
|
|
- Document any ambiguity or blockers in the issue before pausing or switching context.
|
|
|
|
6. **Current Issue Tracking via .gitea File**
|
|
- A file named `.gitea` can exist in the project root, containing the URL of the currently selected Gitea issue (e.g., `https://gitea.schwenk.online/froxxxy/vfbred/issues/3`).
|
|
- The AI assistant will read this file to determine the current project name and issue number for all Gitea-related operations.
|
|
|
|
## Rationale
|
|
These rules ensure that all work is traceable, communication is clear, and project history is auditable. They foster accountability and make onboarding, reviews, and audits more efficient.
|