Thank you for your interest in contributing to this Allen Institute for Cell Science open source project! This document is a set of guidelines to help you contribute to this project.
By participating in this project, you are expected to uphold our Code of Conduct.
The README in the root of the repository should contain or link to
project documentation. If you cannot find the documentation you're
looking for, please file a GitHub issue with details of what
you'd like to see documented.
Typical steps to contribute:
-
Fork the repo on GitHub.
-
Create a branch and make your edits on your branch, pushing back to your fork.
-
Ensure that your changes are working, pass any linting and tests in the project. Add tests and documentation as needed.
-
Submit a pull request to merge your fork's branch into this repository, via GitHub.
- Instructions
- In this repo:
bun install
- clone the viewer repo
- cd into the viewer repo
- build the viewer:
npm run build - type
cat package.json - then
bun link - cd back to this repo
- type
bun link @aics/simularium-viewer
- type
bun dev<= starts the server - Open at http://localhost:5173/
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Currently, two official plugins are available:
- @vitejs/plugin-react uses Babel for Fast Refresh
- @vitejs/plugin-react-swc uses SWC for Fast Refresh
- Make a new version:
npm version [patch/minor/major] - Push the new package.json version:
git push origin main - Push the new tag:
git push origin [NEW_TAG]
Talk to us on one of our community forums.