Contributing Checklist

Use this page before submitting your work. Skip items that clearly do not apply. For example, a news-only change does not need mobile-menu testing.

Review the change

Check the content, implementation, and user experience before running the final commands.

Scope and source

• The change is limited to the issue addressed in the issue/pr.
• Unrelated work is not added sneakily to your pull request.
• Source files are not edited (_site/ and .jekyll-cache/ were not edited or committed).
• Shared information is changed in _data/ instead of copied into several pages.

Pages and content

• Every new public page has an explicit permalink (public address).
• Every public page produces non-empty content and exactly one <h1>.
• The title, search description, official URL, and heading order are correct.
• Internal URLs and asset URLs use relative_url.
• Values inserted into HTML attributes use the existing safe escape pattern.
• Published routes and article filenames remain stable.
• A deliberate public-address change is reflected in tools/verify-site.rb and /sitemap.

Structured data

• Game records contain every required field and point to real pages/assets.
• Department records have matching detail pages and staff group values.
• Public staff profiles have a role, bio, and tracked profile image.
• Stable staff author keys were not renamed accidentally.
• Article authors reference valid staff keys and banners exist.
• Shared links live in _data/site.yml and use https:// for the protocol.

Design and accessibility

• The visual identity and existing component patterns are preserved.
• The layout works at narrow widths, 375px, 768px, and desktop.
• There is no horizontal scrolling or hidden overflow bug.
• Footer columns stack correctly at 540px and below.
• Keyboard focus is visible and follows a logical order.
• Mouse, touch, and keyboard interactions all work.
• Reduced-motion behavior is preserved.
• Hidden interactive content cannot be reached with Tab or a screen reader.
• Disabled controls do not have links or misleading roles.

Finish the contribution

Verification

Verification is also performed through GitHub Actions, but it is good to test this before committing.

• bundle exec jekyll build
• bundle exec htmlproofer ./_site --disable-external --ignore-urls '/minecraft:/'
• bundle exec ruby tools/verify-site.rb ./_site
• node --check assets/js/main.js when JavaScript changed
• git diff --check
• The final diff contains only intended source and documentation changes.

When every relevant item is complete, continue to Making a Pull Request!

Return to Home.