docs: add incompatibleWith authoring rules (fixes #119) - #190
Merged
Conversation
Closes #119. Documents incompatibleWith contributor recipe: when to use (same file/type — Dockerfile, compose.yml, .env.example, pyproject.toml overlay e.g. celery-docker vs flower-docker for celery-worker), symmetric requirement, same-type restriction, example JSON, validation via scripts/ci/validate-registry.py and templates.schema.json, L2 failure on combination. Related to #91.
ulises-jeremias
marked this pull request as ready for review
August 24, 2026 05:05
|
Warning Review limit reachedNext included review available in 6 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
1 participant
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.
Closes #119
Adds contributor-facing
incompatibleWith — when and howrecipe todocs/AUTHORING.md:Dockerfile,compose.yml,.env.example,pyproject.tomloverlay) for the sametype(e.g.celery-dockervsflower-dockerboth forcelery-worker)AlistsB,Bmust listA(validated byscripts/ci/validate-registry.py)typepython scripts/ci/validate-registry.pychecks symmetry and existencescripts/ci/validate-registry.pyandtemplates.schema.jsonKeeps subsection under 30 lines, contributor-focused.
Related to #91.
Validation:
python scripts/ci/validate-registry.py→ ✅ registry ok (6 templates, 19 extensions)