6 KiB
(Draft) Contribute to Logto monorepo
Thanks for your interest in contributing to Logto. We respect the time of community contributors, so it'll be great if we can go through this guide which provides the necessary contribution information before starting your work.
Table of contents
Contribution Type
Bug fixes
We ensure Logto runs correctly with core unit tests, integration tests, and bug bash meetings. However, there's still a chance of missing or getting wrong on something.
If something doesn't work as expected, search in Issues to see if someone has reported the issue.
- If an issue already exists, comment to say you're willing to take it.
- If not, create one before continuing. It'll be great to let other people know you found it and will fix it.
Usually, we'll confirm the details in the issue thread, and you can work on the Pull Request in the meantime.
Warning
Do not report a security issue directly in the public GitHub Issues, since someone may take advantage of it before the fix. Send an email to security@logto.io instead.
Connectors
Connector is the standard way in Logto to connect third-party services like SMS, email, and social identity providers. See Connectors if you don't know the concept yet.
Note
You can find all official connectors here.
Before starting the work, join our Discord channel or email us to double-check if there's an ongoing project for your desired connector. We'll confirm with you your need and the status quo.
You can read this documentation which describes how to implement and test a connector through concrete examples.
Core features
If you find some feature is related to customer identity and doesn't belong to a specific connector, then most likely, it's a core feature.
Since Logto is still in the early stage, it may already be in our roadmap. You can also join our Discord channel or email us to get the details.
The concept of feature varies by the situation, so we'll work with you to figure out the best way to contribute before starting.
Set up the dev environment
Prerequisites
We use the monorepo approach for development. Since pnpm supports monorepo naturally, it's the package manager for Logto.
You'll need these installed to proceed:
Clone and install dependencies
Clone the repo https://github.com/logto-io/logto in the way you like, then execute the command below in the project root:
pnpm i && pnpm prepack
pnpm i installs dependencies, which might take some time, and pnpm prepack builds the necessary workspace dependencies, enabling editors such as VSCode to locate their declarations.
Set up database
Create a .env file with the following content in the project root, or set the environment variable directly:
DB_URL=postgresql://your-postgres-dsn/logto # Replace with your own
Then run pnpm cli db seed to seed data into your database.
Database alteration
If you are upgrading your dev environment from an older version, or facing the Found undeployed database alterations... error when starting Logto, you need to deploy the database alteration first.
Run pnpm alteration deploy and start Logto again. See Database alteration for reference of this command.
If you are developing something with database alterations, see packages/schemas/alteration to learn more.
Add connectors (optional)
Run logto connector link -p . to link all local connectors. You can also use logto connector add <name> -p . to install connector from NPM.
See Manage connectors for details about managing connectors via CLI.
Start dev
Run the command below in the project root:
pnpm dev
The command will watch the changes in most of the packages and restart services when needed.
Make changes
By default, Logto runs in http://localhost:3001, which will redirect you to the Admin Console.
packages/console holds the source code of Admin Console frontend (SPA). Start to make changes and see if the page reloads automatically.
I updated some code, but it doesn't work.
Please report a bug in issues.
Commit and create pull request
We require every commit to be signed, and both the commit message and pull request title follow conventional commits.
You can find repo-specific config in commitlint.config.js, if applicable.
If the pull request remains empty content, it'll be DIRECTLY CLOSED until it matches our contributing guideline.