Before you start
You’ll need a few basic tools installed:
If you only want to edit data or Markdown documentation, you can make changes directly on GitHub without setting up a local environment.
1. Fork the repository
Go to the Phaseo GitHub Repository and click Fork in the top-right corner. This creates your own copy of the project that you can freely edit.2. Clone your fork
3. Create a new branch
It’s best practice to make a new branch for each change you make:fix-{model-name}add-new-organisationimprove-docsupdate-pricing-for-{model-name}
4. Make your changes
Depending on what you want to edit:
If you’re editing data, please follow the schemas and field formats described in Repo Structure.
5. Preview your changes (optional)
If you’d like to preview your edits locally:6. Commit your changes
Once you’re satisfied, commit your work:7. Push your branch
8. Create a Pull Request (PR)
- Go to your fork on GitHub.
- You’ll see a message offering to create a PR - click Compare & Pull Request.
- Fill out the PR template with the appropriate information for your changes.
- Submit the PR.
9. Celebrate
Your contribution will be live once merged. If you made it this far, we appreciate your effort and support.View Contributors
See everyone who’s helped build Phaseo.
Contribution tips
- Keep PRs small and focused - one logical change per PR.
- Attempt to follow conventional commits where possible. Use clear commit prefixes like
fix:,add:, orchore:. - If your change affects data accuracy, include sources or references.
- For large or uncertain ideas, open a GitHub Discussion or message in Discord before coding.
- Always stay respectful and follow our Code of Conduct.
Example workflow summary
Next steps
Repo Structure
Learn about the folder layout and where to find key data files.
Editing a Model
Start with a practical example - updating or adding a model entry.