Skip to content

Add Husky hooks, CI workflow, and contribution guidelines#13

Merged
BeckettFrey merged 7 commits into
mainfrom
automation
May 11, 2026
Merged

Add Husky hooks, CI workflow, and contribution guidelines#13
BeckettFrey merged 7 commits into
mainfrom
automation

Conversation

@BeckettFrey
Copy link
Copy Markdown
Member

@BeckettFrey BeckettFrey commented May 11, 2026

This pull request introduces a comprehensive set of improvements to project infrastructure, code quality enforcement, and documentation. The most significant changes include the addition of a detailed contribution guide, the setup of continuous integration (CI) workflows, and the enforcement of consistent code style and type safety through automated hooks and configuration files. Additionally, minor codebase cleanups and formatting consistency improvements have been made across several files.

Documentation and Contribution Process:

  • Added a detailed contribution guide in .github/CONTRIBUTING.md outlining GitHub Flow, branch protection, CI/CD, and deployment guardrails for both developers and maintainers.
  • Updated AGENTS.md to reference the new contribution guide for agent and human contributor alignment.

Continuous Integration and Code Quality Automation:

  • Introduced a GitHub Actions workflow (.github/workflows/ci.yml) to automatically run linting, type checking, and formatting checks on pull requests and pushes to main.
  • Added Husky hooks:
    • pre-commit runs lint-staged, formatting, and type checking before commits.
    • pre-push runs full lint, format check, type check, and build before pushes.
  • Marked workflow lock files as generated and set merge strategy in .gitattributes.

Code Style and Formatting Consistency:

  • Added .prettierrc.json (empty config for Prettier defaults) and .prettierignore to standardize formatting and ignore build/artifact files. [1] [2]
  • Refactored imports and code style in several files for consistency (e.g., using double quotes, formatting object literals, and improving readability in app/api/releases/route.ts, app/features/page.tsx, app/download/page.tsx, and app/docs/page.tsx). [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

These changes collectively improve the project's maintainability, enforce higher code quality standards, and provide clear guidance for contributors and maintainers.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
voxkit-web Building Building Preview May 11, 2026 7:32pm

@BeckettFrey BeckettFrey merged commit 5a10153 into main May 11, 2026
5 checks passed
@BeckettFrey BeckettFrey deleted the automation branch May 11, 2026 19:40
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.

1 participant