Skip to content

Contributing

Jump to bottom
Bryan Chen edited this page Apr 16, 2026 · 1 revision

Contributing

Issues, ideas, and improvements are welcome.

Typical Workflow

  1. Fork the repository.
  2. Create a focused feature branch.
  3. Commit scoped changes with clear messages.
  4. Open a pull request.

Pull Request Tips

  • Keep PRs focused and reviewable.
  • For UI-heavy changes, include screenshots or short clips.
  • Mention any behavior changes, assumptions, and follow-up tasks.

Required For Hardcoded Changes

If your PR changes hardcoded constants, keys, ids, routes, or default values:

  1. Explain why the old value was changed.
  2. List all affected files and dependent constants.
  3. Update Hardcoded Values and Keys.
  4. Include a short test note proving the new value works.

PhysicsSims Docs

Start Here

Contributor References

Quick Contributor Flow

  1. Read Development Setup
  2. Check Hardcoded Values and Keys
  3. Make changes and verify locally
  4. Update docs in Simulation Catalog or other affected pages
  5. Follow PR checklist in Contributing

Clone this wiki locally