Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions .cursorrules
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,3 @@ All contributors must read `.github/AGENTS.md` for complete guidelines. If any r
2. **Why It Was Necessary**
3. **Testing Performed**
4. **Impact / Risk**

## Dependency Management
- Manage modules with `magex tidy` after import changes.

## Security Reporting
- Do not open public issues for vulnerabilities.
- Follow `SECURITY.md` for responsible disclosure.
6 changes: 3 additions & 3 deletions .github/.env.base
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ GO_COVERAGE_PROVIDER=internal
CODECOV_TOKEN_REQUIRED=false

# Go Coverage Tool Version
GO_COVERAGE_VERSION=v1.1.16 # https://github.com/mrz1836/go-coverage/releases
GO_COVERAGE_VERSION=v1.1.17 # https://github.com/mrz1836/go-coverage/releases
GO_COVERAGE_USE_LOCAL=false # Use local version for development

# Core Coverage Settings
Expand Down Expand Up @@ -235,7 +235,7 @@ REDIS_CACHE_FORCE_PULL=false # Force pull Redis images even when cache
# 🪄 MAGE-X CONFIGURATION
# ================================================================================================

MAGE_X_VERSION=v1.10.3 # https://github.com/mrz1836/mage-x/releases
MAGE_X_VERSION=v1.11.0 # https://github.com/mrz1836/mage-x/releases
MAGE_X_USE_LOCAL=false # Use local version for development
MAGE_X_CI_SKIP_STEP_SUMMARY=true # Skip duplicate test results in step summary (already in test validation summary)
MAGE_X_AUTO_DISCOVER_BUILD_TAGS=true # Enable auto-discovery of build tags
Expand Down Expand Up @@ -308,7 +308,7 @@ NANCY_VERSION=v1.0.52 # https://github.com/sonatype-nexus-commu
# ================================================================================================

# Pre-Commit System
GO_PRE_COMMIT_VERSION=v1.4.5 # https://github.com/mrz1836/go-pre-commit/releases
GO_PRE_COMMIT_VERSION=v1.4.6 # https://github.com/mrz1836/go-pre-commit/releases
GO_PRE_COMMIT_USE_LOCAL=false # Use local version for development

# System Settings
Expand Down
21 changes: 10 additions & 11 deletions .github/AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This file defines the **baseline standards, workflows, and structure** for *all contributors and AI agents* operating within this repository. It serves as the root authority for engineering conduct, coding conventions, and collaborative norms.

It is designed to help AI assistants (e.g., Codex, Claude, Cursor, Sweep AI) and human developers alike understand our practices, contribute clean and idiomatic code, and navigate the codebase confidently and effectively.
It is designed to help AI assistants (e.g., Codex, Claude, Gemini) and human developers alike understand our practices, contribute clean and idiomatic code, and navigate the codebase confidently and effectively.

> Whether reading, writing, testing, or committing code, **you must adhere to the rules in this document.**

Expand All @@ -28,23 +28,22 @@ Our technical standards are organized into focused, portable documents in the `.

### Project Management & Infrastructure
* **[Labeling Conventions](tech-conventions/labeling-conventions.md)** - GitHub label system
* **[CI & Validation](tech-conventions/ci-validation.md)** - Continuous integration and automated checks
* **[Dependency Management](tech-conventions/dependency-management.md)** - Go modules and security
* **[Security Practices](tech-conventions/security-practices.md)** - Vulnerability reporting and secure coding
* **[GitHub Workflows Development](tech-conventions/github-workflows.md)** - Actions workflow best practices

### Build & Project Setup
* **[Governance Documents](tech-conventions/governance-documents.md)** - Project governance and community standards

> 💡 **Start with [tech-conventions/README.md](tech-conventions/README.md)** for a complete index with descriptions.

<br><br>

## 📁 Directory Structure

| Directory | Description |
|------------------|-----------------------------------------------------------------------------------|
| `.github/` | Issue templates, workflows, and community documentation |
| `.vscode/` | VS Code settings and extensions for development |
| `examples/` | Example program demonstrating package usage |
| `.` (root) | Source files and tests for the local package |
| Directory | Description |
|-----------------------------|---------------------------------------------------------|
| `.github/` | Issue templates, workflows, and community documentation |
| `.github/actions/` | GitHub composite actions for CI/CD and automation |
| `.github/ISSUE_TEMPLATE/` | Issue and pull request templates |
| `.github/tech-conventions/` | Technical conventions and standards for development |
| `.github/workflows/` | GitHub Actions workflows for CI/CD |
| `.vscode/` | VS Code settings and extensions for development |
| `.` (root) | Source files and tests for the local package |
1 change: 0 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# ────────────────────────────────────────────────────────────────
# Dependabot Configuration
# Repo: mrz1836/<repo>
#
# Purpose:
# • Keep Go modules, GitHub Actions and DevContainer images/features
Expand Down
13 changes: 0 additions & 13 deletions .github/sweep.yaml

This file was deleted.

66 changes: 5 additions & 61 deletions .github/tech-conventions/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Technical Conventions

> This directory contains modular, portable technical conventions that can be adopted across projects. Each file focuses on a specific aspect of software development.

<br><br>

## 📚 Convention Categories
Expand Down Expand Up @@ -37,13 +35,14 @@ Semantic versioning practices, release tooling with goreleaser, changelog manage
**[Labeling Conventions](labeling-conventions.md)**
GitHub label system for categorizing issues and PRs, including standard labels, usage guidelines, and automated labeling.

### 🤖 AI Usage & Assistant Guidelines
**[AI Compliance](ai-compliance.md)**
Guide to AI assistant configuration files and where to find standards for AI-assisted development.

<br><br>

### 🔧 Infrastructure & Quality

**[CI & Validation](ci-validation.md)**
Continuous integration setup, automated checks, required status checks, and troubleshooting CI failures.

**[Dependency Management](dependency-management.md)**
Go modules management, security scanning, version control practices, and maintaining healthy dependencies.

Expand All @@ -61,59 +60,4 @@ Creating and maintaining GitHub Actions workflows with security, reliability, an
### 🏗️ Build & Project Setup

**[MAGE-X Build Automation](mage-x.md)**
Zero-boilerplate build automation system with 240+ built-in commands that replaces Makefiles. Includes installation, configuration, command reference, and migration guide.

**[Governance Documents](governance-documents.md)**
Essential project files including LICENSE, README, CODE_OF_CONDUCT, SECURITY, and other governance standards.

<br><br>

## 🎯 Using These Conventions

### For New Projects
1. Copy this entire `tech-conventions` directory to your `.github` folder
2. Review each file and adjust project-specific details
3. Reference these conventions in your main documentation

### For Existing Projects
1. Review current practices against these conventions
2. Adopt conventions incrementally
3. Update team documentation to reference relevant sections

### Customization
* These conventions are designed to be forked and modified
* Maintain the structure and formatting for consistency
* Document any project-specific deviations

<br><br>

## 📋 Quick Reference

| Need to... | See... |
|------------------------|-------------------------------------------------------------|
| Write Go code | [Go Essentials](go-essentials.md) |
| Create tests | [Testing Standards](testing-standards.md) |
| Document code | [Commenting & Documentation](commenting-documentation.md) |
| Make commits | [Commit & Branch Conventions](commit-branch-conventions.md) |
| Open a PR | [Pull Request Guidelines](pull-request-guidelines.md) |
| Tag a release | [Release Workflow & Versioning](release-versioning.md) |
| Label issues/PRs | [Labeling Conventions](labeling-conventions.md) |
| Fix CI issues | [CI & Validation](ci-validation.md) |
| Add dependencies | [Dependency Management](dependency-management.md) |
| Report security issues | [Security Practices](security-practices.md) |
| Create workflows | [GitHub Workflows Development](github-workflows.md) |
| Set up build automation| [MAGE-X Build Automation](mage-x.md) |
| Add governance docs | [Governance Documents](governance-documents.md) |

<br><br>

## 🤝 Contributing

These conventions evolve with best practices. To propose changes:

1. Fork the repository
2. Create a feature branch (`feat/improve-testing-standards`)
3. Make your changes with clear reasoning
4. Submit a PR with the "documentation" label

Remember: Good conventions are discovered through practice, not prescribed in theory.
Zero-boilerplate build automation system with 150+ built-in commands that replaces Makefiles. Includes installation, configuration, command reference, and migration guide.
9 changes: 9 additions & 0 deletions .github/tech-conventions/ai-compliance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# AI Usage & Assistant Guidelines

This project documents expectations for AI assistants using a few dedicated files:

- [AGENTS.md](../AGENTS.md) — canonical rules for coding style, workflows, and pull requests used by [Codex](https://chatgpt.com/features/codex).
- [CLAUDE.md](../CLAUDE.md) — quick checklist for the [Claude](https://www.anthropic.com/product) agent.
- [.cursorrules](../../.cursorrules) — machine-readable subset of the policies for [Cursor](https://www.cursor.so/) and similar tools.

Edit `AGENTS.md` first when adjusting these policies, and keep the other files in sync within the same pull request.
Loading