Repository navigation
Docs: update AGENTS, CONTRIBUTING, and the templates - #372
Open
jackspiering wants to merge 3 commits into
Open
jackspiering wants to merge 3 commits into
jackspiering wants to merge 3 commits into
Conversation
CONTRIBUTING.md now points to the template comments for the database case. Two rules from the removed paragraph were missing there: a database image's own HEALTHCHECK comes first, and a service that depends on the database waits with condition: service_healthy.
The documented validation command fails on the template, because SERVICE and IMAGE_URL are empty there. AGENTS.md and CONTRIBUTING.md now give the command with dummy values, as CI uses.
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
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.
Description
Brings
AGENTS.md,CONTRIBUTING.md, the pull request template and the service template in line with what #367 and #368 changed.AGENTS.mdis rewritten: where the rules live, which files change together, how to handle secrets and runtime data, validation and lint commands, and the PR title format.CONTRIBUTING.md:${VAR:?...}plus a# Required:comment);SERVICEPORT, and loosens the naming rules to point at "Deviations from the standard setup";PUID/PGIDwith an explanation (TZstays), puts.envcomments on their own line, replaces#COMPOSE_PROJECT_NAMEwith a note on running a second copy, and removes#version=1.1. The auth key link isconsole.tailscale.com, as in Tailscale's docs.Related Issues
Verification
SERVICE=dummy IMAGE_URL=dummy docker compose config --quiet, before and after.X= # noteyields# note, andX=value # noteyieldsvalue, checked with a scratch Compose project.rumdl check --config .markdownlint.yml .(0.2.78) andgit diff --check origin/mainare clean.Checklist
Additional Context
From an external review of the repository (sections 1 and 3.4).
.envfiles. They are not changed here, because every.envedit makesgit pullstop for existing users.