Skip to content

Commit 84fa829

Browse files
greenfire27claude
andcommitted
CLAUDE.md: the three files that arrived this week
CONTRIBUTING.md, CODE_OF_CONDUCT.md and CHANGELOG.md are new at the root and nothing pointed at them, so a fresh session would not have known they exist or that the changelog wants an entry per change rather than a sweep before a release. Also notes that documentation lives in the sibling wiki repo, since an engine change that alters a script API or an editor workflow usually needs a change there too, and that repo has its own conventions. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014Xh3XULt9PtdCtsaYHGnYE
1 parent 74704a0 commit 84fa829

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,6 @@ Games are composed of **modules**, each defined by a `module.taml` (`engine/sour
113113
- Header include guards use the `_NAME_H_` convention and are wrapped in `#ifndef` checks at every include site (see `platform.h`) — follow this when adding headers.
114114
- New engine source files must be added explicitly to `cmake/EngineSources.cmake` (cross-platform) or `cmake/PlatformSources.cmake` (platform-specific back-ends) to be compiled. These CMake lists are the single source of truth — regenerate your project from them; there are no hand-maintained `.vcxproj`/Xcode/Makefile lists to keep in sync anymore.
115115
- All pull requests target the **`development`** branch, not `master` (master is the stable release branch).
116+
- **A user-visible change needs a `CHANGELOG.md` entry in the same commit or PR** — new behavior, a changed or removed API, a fixed bug. Entries go under the unreleased section, written for someone building a game on the engine rather than for someone working on it. Written afterwards, they do not get written: the previous changelog lived on the wiki, was reconstructed from `git log` after each merge, and stopped in 2013.
117+
- **`CONTRIBUTING.md`** (how to submit a change, and the C++/script standards) and **`CODE_OF_CONDUCT.md`** are at the repo root. There is no contributor agreement to sign; a contribution must simply be legally yours to give and MIT-compatible. Governance follows Torque3D's model — see `CONTRIBUTING.md` rather than looking for a steering committee charter, which was retired.
118+
- **Documentation lives in the sibling `Torque2D.wiki` repo**, which is separate and has its own conventions — every root `.md` there is a published page. Engine changes that alter a script API or an editor workflow usually need a wiki change too.

0 commit comments

Comments
 (0)