Skip to content

Conversation

BigLep
Copy link
Member

@BigLep BigLep commented Oct 16, 2025

Summary

  • Added CONTRIBUTING.md with contribution guidelines covering:
    • Conventional commits for all commits and PR titles
    • GitHub issue references in PR descriptions
    • Visual evidence (screenshots/terminal output) for user-facing changes
    • Draft PR workflow
    • Code quality standards (concise comments, self-documenting code)
  • Added AGENTS.md to ensure AI coding tools follow the contribution guidelines

🤖 Generated with help from Claude Code

@BigLep BigLep requested review from SgtPooki, Copilot and rvagg October 16, 2025 20:49
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR establishes contribution guidelines and AI agent standards for the repository by adding two new documentation files.

  • Added CONTRIBUTING.md with comprehensive contribution guidelines including conventional commits, issue references, visual evidence requirements, and code quality standards
  • Added AGENTS.md to ensure AI coding tools follow the contribution guidelines

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
CONTRIBUTING.md Establishes project contribution standards covering commit conventions, PR requirements, and code quality expectations
AGENTS.md Directs AI coding assistants to follow the contribution guidelines defined in CONTRIBUTING.md

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@BigLep
Copy link
Member Author

BigLep commented Oct 16, 2025

This came about for me when assigning @copilot to take on easy issues that were opened. It wasn't following conventional commits and I don't want to have to clean up after the "agents" going forwards...

@BigLep BigLep self-assigned this Oct 16, 2025
Add contribution guidelines covering conventional commits, issue references,
visual evidence for changes, draft PR workflow, and code quality standards.
Add AGENTS.md to ensure AI tools follow contribution guidelines.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@BigLep BigLep force-pushed the biglep/add-contributing-and-agents branch from 2b8f80b to 4722db4 Compare October 17, 2025 01:22
BigLep and others added 2 commits October 16, 2025 18:27
- Reorganize CONTRIBUTING.md with clearer section structure
- Add Contributing section to README.md linking to CONTRIBUTING.md
- List key contribution topics (commit conventions, PR workflow, code quality)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Copy link
Collaborator

@SgtPooki SgtPooki left a comment

Choose a reason for hiding this comment

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

LGTM.. AGENTs or CONTRIBUTING could be fleshed out further to provide better context of the goals of the project too:

  1. reference implementation: stay away from wide optionality and use opinionated best practices, explaining why we did things a certain way. (AI creating PRs automatically should require us to fill out areas where there is ambiguity)
  2. everything should be documented well: it's a learning resource

Copy link
Member

@rvagg rvagg left a comment

Choose a reason for hiding this comment

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

AGENTS.md need a bit more work, it should be instructions for agents, not about how to use agents, since these typically end up in contexts. But I'll follow up on that, I'm just in the process of cleaning up the Synapse one, I'll come back here and do the same

@rvagg rvagg merged commit 5c204ed into master Oct 20, 2025
11 of 12 checks passed
@rvagg rvagg deleted the biglep/add-contributing-and-agents branch October 20, 2025 01:15
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.

3 participants