Skip to content

Conversation

@louislelay
Copy link
Contributor

This PR adds and improves the changelog structure, and introduces a contributors list:

  • Added a global CHANGELOG.md to track repo-wide updates
  • Moved changelog sections from each model's README.md into dedicated CHANGELOG.md files, and linked them from the corresponding READMEs (created missing changelogs where needed)
  • Created a CONTRIBUTORS.md listing all contributors alphabetically
  • Added a PR template under .github/pull_request_template.md to remind contributors to update changelogs and the contributors list
  • Updated CONTRIBUTING.md to include new expectations
  • Also cleaned up some formatting in the model README files

A few notes:

  • In the contributors list, I separated core contributors (Google DeepMind) from the community based on names I recognized so it will likely need to be adjusted in case I missed anyone!
  • In the global changelog, I only added the Menagerie release date and this contribution. Wasn’t sure if previous changes were meant to be backfilled there.

Fixes: #81

Copy link
Collaborator

@kevinzakka kevinzakka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing job @louislelay, I know doing all these changes must not have been easy!

@kevinzakka kevinzakka merged commit 5b4951c into google-deepmind:main Apr 23, 2025
2 of 3 checks passed
@louislelay
Copy link
Contributor Author

Thanks @kevinzakka, there were quite a few files to go through haha!

@louislelay louislelay deleted the feat/adds-changelog-and-contributors-files branch April 24, 2025 03:01
donghoon11 pushed a commit to donghoon11/mujoco_menagerie that referenced this pull request May 7, 2025
…gelog-and-contributors-files

Adds changelog structure, contributor list, and PR template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CHANGELOG.md and contributors section.

2 participants