Files
Template-NPM/CONTRIBUTING.md
T
jmiller 7a7d855d1e
Universal: Pre-Release / Build Pre-Release (${{ inputs.stability || github.ref_name }}) (push) Successful in 9s
Branch Policy Check / Verify merge target (pull_request) Failing after 2s
Universal: PR Check / Branch Policy (pull_request) Failing after 1s
Universal: Changelog Validation / Validate CHANGELOG.md (pull_request) Failing after 5s
Universal: Build & Release / Promote to RC (pull_request) Has been skipped
Universal: PR Check / Secret Scan (pull_request) Successful in 5s
Universal: PR Check / Validate PR (pull_request) Successful in 6s
Generic: Repo Health / Site Health (pull_request) Has been skipped
Generic: Repo Health / Access control (pull_request) Successful in 1s
Generic: Standards Compliance / Secret Scanning (pull_request) Successful in 4s
Generic: Standards Compliance / License Header Validation (pull_request) Successful in 3s
Generic: Project CI / Lint & Validate (pull_request) Successful in 16s
Universal: Build & Release / Build & Release Pipeline (pull_request) Failing after 10s
Generic: Standards Compliance / Repository Structure Validation (pull_request) Failing after 4s
Generic: Standards Compliance / Coding Standards Check (pull_request) Successful in 4s
Generic: Standards Compliance / Workflow Configuration Check (pull_request) Failing after 4s
Generic: Standards Compliance / Documentation Quality Check (pull_request) Successful in 3s
Generic: Standards Compliance / README Completeness Check (pull_request) Failing after 4s
Generic: Standards Compliance / Git Repository Hygiene (pull_request) Successful in 3s
Generic: Standards Compliance / Line Length Check (pull_request) Successful in 4s
Generic: Standards Compliance / Script Integrity Validation (pull_request) Successful in 6s
Generic: Standards Compliance / File Naming Standards (pull_request) Successful in 3s
Generic: Standards Compliance / Insecure Code Pattern Detection (pull_request) Successful in 3s
Generic: Standards Compliance / Version Consistency Check (pull_request) Successful in 47s
Generic: Standards Compliance / Dead Code Detection (pull_request) Successful in 5s
Generic: Standards Compliance / File Size Limits (pull_request) Successful in 4s
Generic: Standards Compliance / Binary File Detection (pull_request) Successful in 3s
Generic: Standards Compliance / Code Complexity Analysis (pull_request) Successful in 42s
Generic: Standards Compliance / TODO/FIXME Tracking (pull_request) Successful in 3s
Generic: Standards Compliance / Code Duplication Detection (pull_request) Successful in 43s
Generic: Standards Compliance / Broken Link Detection (pull_request) Successful in 4s
Generic: Standards Compliance / API Documentation Coverage (pull_request) Successful in 3s
Generic: Standards Compliance / Accessibility Check (pull_request) Successful in 4s
Generic: Standards Compliance / Performance Metrics (pull_request) Successful in 3s
Generic: Standards Compliance / Unused Dependencies Check (pull_request) Successful in 41s
Generic: Standards Compliance / Dependency Vulnerability Scanning (pull_request) Successful in 43s
Generic: Standards Compliance / Terraform Configuration Validation (pull_request) Successful in 8s
Universal: Auto-Assign / Assign unassigned issues and PRs (pull_request_target) Successful in 1s
Generic: Standards Compliance / Enterprise Readiness Check (pull_request) Successful in 37s
Branch Cleanup / Delete merged branch (pull_request) Successful in 1s
RC Revert / Rename rc/ back to dev/ (pull_request) Has been skipped
Universal: Workflow Sync Trigger / Sync workflows to live repos (pull_request) Successful in 11s
Generic: Standards Compliance / Repository Health Check (pull_request) Successful in 42s
Generic: Project CI / Tests (pull_request) Has been cancelled
Universal: PR Check / Build RC Package (pull_request) Has been cancelled
Universal: PR Check / Report Issues (pull_request) Has been cancelled
Generic: Repo Health / Scripts governance (pull_request) Has been cancelled
Generic: Repo Health / Repository health (pull_request) Has been cancelled
Generic: Repo Health / Report: Scripts Governance (pull_request) Has been cancelled
Generic: Repo Health / Report: Repository Health (pull_request) Has been cancelled
Generic: Standards Compliance / Compliance Summary (pull_request) Has been cancelled
fix(sync): correct own case label Template-MCP -> Template-NPM
PR #24 fixed this but concurrent workflow-sync-trigger relocation churn
reverted the custom/ copy to the old label. Since the trigger lives in
custom/ (never cascaded by the sync tool), it can't self-heal — fix directly
so $REPO=Template-NPM matches and Phase 2 runs with --platform-filter npm.

Claude-Session: https://claude.ai/code/session_01DQEMmJPe61ya7HDfA6BHP8
2026-07-14 15:17:19 -05:00

4.6 KiB

Contributing to Template-NPM

We appreciate your interest in contributing to this project! This document provides guidelines for contributing.

Table of Contents

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to hello@mokoconsulting.tech.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Set up the development environment
  4. Create a new branch for your work

How to Contribute

Reporting Bugs

  • Use the GitHub issue tracker
  • Describe the bug clearly with steps to reproduce
  • Include relevant logs, screenshots, or error messages
  • Specify your environment (OS, version, etc.)

Suggesting Enhancements

  • Use the GitHub issue tracker
  • Clearly describe the enhancement and its benefits
  • Provide examples of how it would work

Contributing Code

  • Pick an issue or create one
  • Fork the repository and create a branch
  • Make your changes following the project conventions
  • Write or update tests as needed
  • Submit a pull request

Development Workflow

  1. Ensure your fork is up to date with the main repository
  2. Create a feature branch from main
  3. Make your changes
  4. Test your changes thoroughly
  5. Commit your changes with clear messages
  6. Push to your fork
  7. Create a pull request

Commit Messages

Follow the conventional commit format:

<type>(<scope>): <subject>

<body>

<footer>

Types: feat, fix, docs, style, refactor, test, chore, ci, build, perf, revert

Example:

feat(docs): add contributing guidelines

Add comprehensive contributing guidelines to help new contributors
understand the development workflow and coding standards.

Pull Request Process

  1. Update documentation for any new features
  2. Follow the project's coding style and conventions
  3. Ensure all tests pass
  4. Update the CHANGELOG.md with your changes
  5. Request review from maintainers
  6. Address any feedback promptly
  7. Once approved, your PR will be merged

Style Guidelines

  • Follow the .editorconfig settings
  • Use tabs for indentation (width: 2 spaces)
  • Ensure files end with a newline
  • Use LF line endings (except for Windows-specific files)
  • Trim trailing whitespace (except in Markdown)

Questions?

If you have questions about contributing, feel free to open an issue or contact the maintainers.

Revision History

Date Version Author Notes
2026-01-16 0.1.0 Copilot Initial contributing guidelines

Infrastructure Standards

All repositories in the MokoConsulting org follow these conventions:

Release Tags

Every repo maintains 5 standard release channel tags:

  • development - Active development builds
  • alpha - Early internal testing
  • beta - Broader testing / client UAT
  • release-candidate - Final QA before production
  • stable - Production release

Branch Protection

  • main is protected; only jmiller can push directly
  • All other contributors must use pull requests
  • PRs are automatically reviewed by Claude Code

CI/CD

  • MokoGitea Actions runs all CI workflows
  • GitHub Actions are disabled on mirrored repos
  • Workflows live in both .github/workflows/ and .mokogitea/workflows/

Update Servers (Joomla)

In manifest <updateservers>, MokoGitea must be priority 1, GitHub priority 2.

Secrets

All repos have GA_TOKEN and GH_TOKEN as Actions secrets for API access.