Skip to content

Commit ac646d8

Browse files
authored
[Sync] Update project files from source repository (c8d31f6) (#77)
* sync(docs): update tech conventions and tool versions * docs(README): update AI compliance section to AI usage guidelines * chore(deps): remove repository reference from dependabot config * chore(deps): update go-bt and go-safe-conversion versions
1 parent 66f18f1 commit ac646d8

18 files changed

+67
-593
lines changed

.cursorrules

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,3 @@ All contributors must read `.github/AGENTS.md` for complete guidelines. If any r
2020
2. **Why It Was Necessary**
2121
3. **Testing Performed**
2222
4. **Impact / Risk**
23-
24-
## Dependency Management
25-
- Manage modules with `magex tidy` after import changes.
26-
27-
## Security Reporting
28-
- Do not open public issues for vulnerabilities.
29-
- Follow `SECURITY.md` for responsible disclosure.

.github/.env.base

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ GO_COVERAGE_PROVIDER=internal
150150
CODECOV_TOKEN_REQUIRED=false
151151

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

156156
# Core Coverage Settings
@@ -235,7 +235,7 @@ REDIS_CACHE_FORCE_PULL=false # Force pull Redis images even when cache
235235
# 🪄 MAGE-X CONFIGURATION
236236
# ================================================================================================
237237

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

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

314314
# System Settings

.github/AGENTS.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
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.
66

7-
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.
7+
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.
88

99
> Whether reading, writing, testing, or committing code, **you must adhere to the rules in this document.**
1010
@@ -28,23 +28,22 @@ Our technical standards are organized into focused, portable documents in the `.
2828

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

36-
### Build & Project Setup
37-
* **[Governance Documents](tech-conventions/governance-documents.md)** - Project governance and community standards
38-
3935
> 💡 **Start with [tech-conventions/README.md](tech-conventions/README.md)** for a complete index with descriptions.
4036
4137
<br><br>
4238

4339
## 📁 Directory Structure
4440

45-
| Directory | Description |
46-
|------------------|-----------------------------------------------------------------------------------|
47-
| `.github/` | Issue templates, workflows, and community documentation |
48-
| `.vscode/` | VS Code settings and extensions for development |
49-
| `examples/` | Example program demonstrating package usage |
50-
| `.` (root) | Source files and tests for the local package |
41+
| Directory | Description |
42+
|-----------------------------|---------------------------------------------------------|
43+
| `.github/` | Issue templates, workflows, and community documentation |
44+
| `.github/actions/` | GitHub composite actions for CI/CD and automation |
45+
| `.github/ISSUE_TEMPLATE/` | Issue and pull request templates |
46+
| `.github/tech-conventions/` | Technical conventions and standards for development |
47+
| `.github/workflows/` | GitHub Actions workflows for CI/CD |
48+
| `.vscode/` | VS Code settings and extensions for development |
49+
| `.` (root) | Source files and tests for the local package |

.github/dependabot.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# ────────────────────────────────────────────────────────────────
22
# Dependabot Configuration
3-
# Repo: mrz1836/<repo>
43
#
54
# Purpose:
65
# • Keep Go modules, GitHub Actions and DevContainer images/features

.github/sweep.yaml

Lines changed: 0 additions & 13 deletions
This file was deleted.

.github/tech-conventions/README.md

Lines changed: 5 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Technical Conventions
22

3-
> This directory contains modular, portable technical conventions that can be adopted across projects. Each file focuses on a specific aspect of software development.
4-
53
<br><br>
64

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

38+
### 🤖 AI Usage & Assistant Guidelines
39+
**[AI Compliance](ai-compliance.md)**
40+
Guide to AI assistant configuration files and where to find standards for AI-assisted development.
41+
4042
<br><br>
4143

4244
### 🔧 Infrastructure & Quality
4345

44-
**[CI & Validation](ci-validation.md)**
45-
Continuous integration setup, automated checks, required status checks, and troubleshooting CI failures.
46-
4746
**[Dependency Management](dependency-management.md)**
4847
Go modules management, security scanning, version control practices, and maintaining healthy dependencies.
4948

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

6362
**[MAGE-X Build Automation](mage-x.md)**
64-
Zero-boilerplate build automation system with 240+ built-in commands that replaces Makefiles. Includes installation, configuration, command reference, and migration guide.
65-
66-
**[Governance Documents](governance-documents.md)**
67-
Essential project files including LICENSE, README, CODE_OF_CONDUCT, SECURITY, and other governance standards.
68-
69-
<br><br>
70-
71-
## 🎯 Using These Conventions
72-
73-
### For New Projects
74-
1. Copy this entire `tech-conventions` directory to your `.github` folder
75-
2. Review each file and adjust project-specific details
76-
3. Reference these conventions in your main documentation
77-
78-
### For Existing Projects
79-
1. Review current practices against these conventions
80-
2. Adopt conventions incrementally
81-
3. Update team documentation to reference relevant sections
82-
83-
### Customization
84-
* These conventions are designed to be forked and modified
85-
* Maintain the structure and formatting for consistency
86-
* Document any project-specific deviations
87-
88-
<br><br>
89-
90-
## 📋 Quick Reference
91-
92-
| Need to... | See... |
93-
|------------------------|-------------------------------------------------------------|
94-
| Write Go code | [Go Essentials](go-essentials.md) |
95-
| Create tests | [Testing Standards](testing-standards.md) |
96-
| Document code | [Commenting & Documentation](commenting-documentation.md) |
97-
| Make commits | [Commit & Branch Conventions](commit-branch-conventions.md) |
98-
| Open a PR | [Pull Request Guidelines](pull-request-guidelines.md) |
99-
| Tag a release | [Release Workflow & Versioning](release-versioning.md) |
100-
| Label issues/PRs | [Labeling Conventions](labeling-conventions.md) |
101-
| Fix CI issues | [CI & Validation](ci-validation.md) |
102-
| Add dependencies | [Dependency Management](dependency-management.md) |
103-
| Report security issues | [Security Practices](security-practices.md) |
104-
| Create workflows | [GitHub Workflows Development](github-workflows.md) |
105-
| Set up build automation| [MAGE-X Build Automation](mage-x.md) |
106-
| Add governance docs | [Governance Documents](governance-documents.md) |
107-
108-
<br><br>
109-
110-
## 🤝 Contributing
111-
112-
These conventions evolve with best practices. To propose changes:
113-
114-
1. Fork the repository
115-
2. Create a feature branch (`feat/improve-testing-standards`)
116-
3. Make your changes with clear reasoning
117-
4. Submit a PR with the "documentation" label
118-
119-
Remember: Good conventions are discovered through practice, not prescribed in theory.
63+
Zero-boilerplate build automation system with 150+ built-in commands that replaces Makefiles. Includes installation, configuration, command reference, and migration guide.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# AI Usage & Assistant Guidelines
2+
3+
This project documents expectations for AI assistants using a few dedicated files:
4+
5+
- [AGENTS.md](../AGENTS.md) — canonical rules for coding style, workflows, and pull requests used by [Codex](https://chatgpt.com/features/codex).
6+
- [CLAUDE.md](../CLAUDE.md) — quick checklist for the [Claude](https://www.anthropic.com/product) agent.
7+
- [.cursorrules](../../.cursorrules) — machine-readable subset of the policies for [Cursor](https://www.cursor.so/) and similar tools.
8+
9+
Edit `AGENTS.md` first when adjusting these policies, and keep the other files in sync within the same pull request.

0 commit comments

Comments
 (0)