Skip to content

Update Contributor Guidelines and Agent instructions#95

Draft
Jeremy Wildfire (jwildfire) wants to merge 3 commits into
devfrom
fix-93
Draft

Update Contributor Guidelines and Agent instructions#95
Jeremy Wildfire (jwildfire) wants to merge 3 commits into
devfrom
fix-93

Conversation

@jwildfire
Copy link
Copy Markdown
Contributor

Overview

Updates to Contributor Guidelines regarding Example best practices and new file capturing AI Agent instructions.

Test Notes/Sample Code

Connected Issues

@jwildfire
Copy link
Copy Markdown
Contributor Author

cc: Jon Harmon (@jonthegeek)

Comment on lines +5 to +9
## Quick Links

- **[CONTRIBUTING.md](CONTRIBUTING.md)** - **READ THIS FIRST** - Complete development workflow, branching strategy, release process
- **Example Framework** - See [Examples section below](#examples)
- **Package Structure** - See [Package Structure section below](#package-structure)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd go very vanilla for this. I don't think the agent will gain anything (other than confusion) from these links.

I'd probably avoid all links throughout this. It's going to be looking at these as raw text, so including links requires an extra step. I think "the release order section of CONTRIBUTING.md" would work better than [CONTRIBUTING.md](CONTRIBUTING.md#release-order), for example.

@jwildfire Jeremy Wildfire (jwildfire) linked an issue Dec 3, 2025 that may be closed by this pull request
@nandriychuk
Copy link
Copy Markdown
Contributor

{qcthat} Report: PR-Associated Issues

█ A qcthat issue test matrix with 0 milestones, 2 issues, and 0 tests
└─█─Milestone: <none> (2 issues, 0 tests)
  ├─📥─Documentation Task 94: Create basic instructions for AI assistants
  │ └─(no tests)
  └─📥─Documentation Task 93: Update Contributor guidelines to document new approach for examples
    └─(no tests)
# Issue state: 📥 = open, ☑️ = closed (completed), ⛔ = closed (won't fix)
# Test disposition: ✅ = passed, ❌ = failed, 🚫 = skipped
⭕ 2 issues lack tests

@nandriychuk
Copy link
Copy Markdown
Contributor

{qcthat} Report: User Acceptance

No issues are awaiting UAT.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create basic instructions for AI assistants Update Contributor guidelines to document new approach for examples

3 participants