mmo-ref/mudlet
1
0
Fork 0
mirror of https://github.com/Mudlet/Mudlet synced 2026-08-13 18:26:27 -04:00
Code Issues Projects Releases Packages Wiki Activity
mudlet/docs/GITHUB.md
Kebap 9a527a4e04
Infra: Move developer documentation to /docs (#8120) 
#### Brief overview of PR changes/additions
- Create a /docs folder for prose info for developers
- Move a few files in there including /.github/README.md, it was taking
precedence over the /README in Github's rendering

#### Motivation for adding to Mudlet
Fix #8107

#### Other info (issues closed, discussion etc)
- Alternative to #8108 simply removing the info file
- Follow-up to #1348 which moved the file from / to /.github
-
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file
suggests a list of relevant files, and explains how .github folder will
take precedence over root, then /docs folders.
2025-08-27 10:22:23 +02:00

2 KiB
Raw Permalink Blame History

.github Directory

This directory contains GitHub-specific configuration files and templates that help manage the Mudlet project's development workflow.

Files and Their Purpose

Issue & PR Management

  • ISSUE_TEMPLATE/ - Templates for bug reports and feature requests
    • 01-bug-report.md - Standard bug report template
    • 02-feature-request.md - Feature request template
    • config.yml - Issue template configuration
  • PULL_REQUEST_TEMPLATE.md - Default template for pull requests
  • CODEOWNERS - Automatically assigns reviewers to PRs (currently assigns @Mudlet/mudlet-makers)

Automation & CI/CD

  • workflows/ - GitHub Actions workflow definitions
    • build-mudlet.yml / build-mudlet-win.yml - Build automation for different platforms
    • codeql-analysis.yml - Security analysis
    • codespell-analysis.yml - Spell checking
    • clangtidy-*.yml - C++ code quality analysis
    • dangerjs.yml - PR validation and automation
    • generate-*.yml - Various content generation workflows
    • update-*.yml - Automated update workflows for dependencies and translations
    • And many more specialized automation workflows

Configuration Files

  • dependabot.yml - Dependabot configuration for automated dependency updates
  • pr-labeler.yml - Automatic labeling of pull requests based on file changes
  • repo-metadata.yml - Repository metadata configuration
  • codespell-wordlist.txt - Custom dictionary for spell checking

Developer Tools

  • copilot-instructions.md - GitHub Copilot AI assistant instructions (symlinked from centralized source)
  • codeql/ - CodeQL security analysis configuration

AI Assistant Integration

This directory includes copilot-instructions.md which is part of Mudlet's centralized AI assistant system. For complete information about AI assistant setup, supported tools, and Windows symlink configuration, see AI-ASSISTANTS.md in the project root.