Files
3DPrintMeetup/.github/copilot-instructions.md
2025-12-02 17:04:54 -06:00

2.4 KiB
Raw Permalink Blame History

# GitHub Copilot Instructions

**Never use the unicode multiplication symbol (×, U+00D7) in any documentation, code, or markdown.**

Always use a plain lowercase 'x' for dimensions and multiplication.

- WRONG: `25mm × 25mm × 25mm`
- CORRECT: `25mm x 25mm x 25mm`

# Git Instructions

- If a git command fails due to authentication reasons, retry the command exactly once.

# Wiki Tagging Standards

All wiki pages should use YAML frontmatter for tagging.

## Challenge Tags
All challenge pages must include the following tags:
- `challenge`: Identifies the page as a challenge.
- `challenge-NNN`: A unique sequential identifier.
   - `challenge-001`: October 2025
   - `challenge-002`: November 2025
   - `challenge-003`: December 2025
   - Increment for subsequent months.
- `archive`: (Optional) Use this tag when the challenge is no longer active.

## Visibility Tags
- `hidden`: Use this tag to prevent the page from being published to the fargo3d.com website.

# Challenge Lifecycle

Challenges follow a specific monthly cycle:
1. **Announcement**: A challenge is announced at the meetup in Month X.
2. **Execution**: Participants work on the challenge between Month X and Month X+1.
3. **Judging**: Results are brought to and judged at the meetup in Month X+1.

**Example:**
- **November Challenge**: Announced in November, Judged in December.
- **December Challenge**: Announced in December, Judged in January.

**Wiki Page Roles:**
- **Current-Challenge.md**: Displays the challenge currently in the "Execution" phase (announced last month, to be judged at the upcoming meetup).
- **Upcoming-Challenge.md**: Displays the challenge to be announced at the upcoming meetup.

# Content Synchronization

The `wiki-fargo3d` submodule contains the official documentation. Some content is mirrored in the main repository root.

- **Readme.md vs wiki-fargo3d/Home.md**: Keep announcements and general descriptions in sync.
- **challenges.md vs wiki-fargo3d/Current-Challenge.md**: `challenges.md` should reflect the active challenge found in the wiki.
- **itinerary.md vs wiki-fargo3d/Itinerary.md**: Keep meeting schedules in sync.

## Git Workflow for Wiki Updates
1. Make changes in `wiki-fargo3d/`.
2. Commit and push changes in `wiki-fargo3d`.
3. Go to root `P:\3dPrintMeetup`.
4. Commit the submodule update.
5. Push root changes.

## Example Front Matter

```yaml
---
tags:
 - challenge
 - challenge-002
---
```