docs: Add example structure and policy to contributing guide#3028
Merged
docs: Add example structure and policy to contributing guide#3028
Conversation
Explains the two-tier example system: core examples in main repo (Basic/Advanced) maintained to high standards, and community examples in mesa-examples for user contributions. Clarifies contribution paths and maintenance expectations for each tier.
EwoutH
force-pushed
the
example_contrib_guide
branch
from
2fffae3 to
b0d4553
Compare
wang-boyu
reviewed
Dec 28, 2025
wang-boyu
approved these changes
Dec 28, 2025
quaquel
approved these changes
Dec 28, 2025
Member
quaquel
left a comment
quaquel
left a comment
There was a problem hiding this comment.
very clear and thorough write-up. Thanks and let's get this merged.
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
3 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.
I noticed we never properly wrote up our policy on example models after the discussions in #2330 and #2349 and merge in #2358. This adds that to the contributing guide in a concise matter.