Skip to content

README.md

Latest commit

 

History

History
81 lines (55 loc) · 2.68 KB

README.md

File metadata and controls

81 lines (55 loc) · 2.68 KB
Raw

Machine Learning Compatible Game Engine — GitHub Defaults

This repository contains organization-level GitHub defaults for the Machine Learning Compatible Game Engine organization.

It is not the main engine repository. Instead, it stores lightweight community files, issue templates, pull request guidance, and support/security information that can be reused across repositories in the organization.

Purpose

The goal of this repository is to keep project maintenance simple and consistent.

It provides:

  • default contribution guidelines
  • default security reporting guidance
  • default support instructions
  • reusable issue templates
  • a reusable pull request template
  • a central place for organization-level GitHub metadata

Included files

CONTRIBUTING.md
SECURITY.md
SUPPORT.md
.github/
  PULL_REQUEST_TEMPLATE.md
  ISSUE_TEMPLATE/
    bug_report.yml
    cleanup.yml
    documentation.yml

Repository role

This .github repository acts as a shared maintenance layer for the organization.

Individual repositories may still define their own files when they need project-specific rules. When a repository has its own contributing guide, security policy, support file, issue templates, or pull request template, that local version should take priority for that repository.

Organization focus

The Machine Learning Compatible Game Engine organization explores game engine architecture, simulation, teaching tools, and research-oriented experiments around systems that can be used, controlled, extended, or evaluated by machine learning agents.

The broader direction includes:

  • game engines designed with machine learning compatibility in mind
  • simulation environments for agents
  • interactive graphics and engine architecture experiments
  • educational documentation
  • research prototypes and archived thesis-related work

Maintenance principles

The default files in this repository should stay:

  • lightweight
  • easy to read
  • generic enough to apply across repositories
  • strict enough to prevent confusion
  • simple enough to maintain long-term

Avoid adding heavy process, unnecessary bureaucracy, or repository-specific instructions here.

When to edit this repository

Edit this repository when you want to change organization-wide GitHub defaults.

Examples:

  • improving pull request guidance
  • changing issue templates
  • updating security reporting instructions
  • adding organization profile files
  • standardizing support information
  • cleaning up shared GitHub metadata

For repository-specific documentation, edit the target repository instead.

Notes

This repository is part of the organizational infrastructure for the Machine Learning Compatible Game Engine project ecosystem.