Repository navigation
docs: replace the contributing guide with the shared one - #40
Merged
Merged
Conversation
Delete CONTRIBUTING.md so GitHub shows the shared guide from dnd-mapp/.github, which holds the rules that every repository shares. Move what only this repository needs to docs/contributing/README.md: the project layout, the rules for changing the code, the build and test steps, the extra checks, the breaking change rules, and the release steps. Repoint the links in AGENTS.md and the README. Drop the text about contributors without write access, since only maintainers open pull requests now. The README links both guides by URL, since npm cannot resolve a relative link. Closes #38
NoNamer777
enabled auto-merge
October 9, 2026 08:24
dnd-mapp-bot
approved these changes
Oct 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
This repository kept its own
CONTRIBUTING.md, and most of it repeated the rules that every D&D Mapp repository shares. The fifteen copies had drifted, so a change to a shared rule had to land in fifteen places. dnd-mapp/.github#12 moved those rules into one guide indnd-mapp/.github, but GitHub only shows that guide in a repository that has noCONTRIBUTING.mdof its own.What
CONTRIBUTING.mdis gone, and what only this repository needs moved todocs/contributing/README.md: the project layout, the rules for changing the code, the build and test steps, the extra checks, the breaking change rules, and the release steps. The links inAGENTS.mdand the README now point at the shared guide or the new page, and nothing in the repository targetsCONTRIBUTING.mdanymore.The parts that the shared guide now covers were dropped rather than copied: setup, hooks, the general code style, branches, commits, and the pull request rules. That includes the text about contributors without write access, since only maintainers open pull requests now. The README links both guides by URL, since npm cannot resolve a relative link.
Test plan
pnpm run format-check,pnpm run lint-md, andactionlintpass.git grep CONTRIBUTING.mdonly finds links to the shared guide.Closes #38