Fedimint Web Sdk

Appearance

Contributing ​

Thanks for your interest in contributing to the Fedimint Web Sdk! Please take a moment to review this document before submitting a pull request.

Overview ​

This guide is intended to help you get started with contributing. By following these steps, you will understand the development process and workflow.

WARNING

Please ask first before starting work on any significant new features. This includes things like adding new services, features, or changing the behavior of existing features.

1. Cloning the repository ​

To start contributing to the project, clone it to your local machine using git:

bash
git clone https://github.com/fedimint/fedimint-web-sdk.git

Or the GitHub CLI:

bash
gh repo clone fedimint/fedimint-web-sdk

2. Installing Node.js and pnpm ​

Fedimint Web Sdk uses Node.js with pnpm workspaces to manage multiple projects. You can run the following command in your terminal to check your local Node.js version.

bash
node -v

If node@20.x is not installed, you can install via fnm (recommended) or from the official website.

Once Node.js is installed, run the following to install Corepack. Corepack automatically installs and manages pnpm@9.12.0.

bash
corepack enable

3. Installing dependencies ​

Once in the project's root directory, run the following command to install pnpm (via Corepack) and the project's dependencies:

bash
pnpm install

After the install completes, pnpm links packages across the project for development and git hooks are set up.

4. Running the dev playgrounds ​

To start the local development playgrounds, run one of the following commands. These commands run playground apps, located at ./playgrounds, that are set up for trying out code while making changes.

bash
pnpm dev              # aliased to `pnpm dev:core`
pnpm dev:core         # `@fedimint/core-web` + Vite + React app
pnpm dev:next         # `@fedimint/core-web` + Next.js app
# pnpm dev:react      # TBD
pnpm dev:bare         # HTML + VanillaJS app (no framework)

Once a playground dev server is running, you can make changes to any of the package source files (e.g. packages/react) and it will automatically update the playground.

5. Running the test suite ​

Fedimint web SDK uses Vitest to run tests. See the testing docs for more information.

6. Writing documentation ​

Documentation is crucial to helping developers of all experience levels use Fedimint Web SDK. We use VitePress for the documentation site (located at ./docs). To start the site in dev mode, run:

bash
pnpm docs:dev

Try to keep documentation brief and use plain language so folks of all experience levels can understand. If you think something is unclear or could be explained better, you are welcome to open a pull request.

7. Submitting a pull request ​

When you're ready to submit a pull request, you can follow these naming conventions:

  • Pull request titles use the Imperative Mood (e.g., Add something, Fix something).
  • Changesets use past tense verbs (e.g., Added something, Fixed something).

When you submit a pull request, GitHub will automatically lint, build, and test your changes. If you see an ❌, it's most likely a bug in your code. Please, inspect the logs through the GitHub UI to find the cause.

Please make sure that "Allow edits from maintainers" is enabled so the core team can make updates to your pull request if necessary.

8. Versioning ​

When adding new features or fixing bugs, we'll need to bump the package versions. We use Changesets to do this.

TIP

Only changes to the codebase that affect the public API or existing behavior (e.g. bugs) need changesets.

Each changeset defines which packages should be published and whether the change should be a major/minor/patch release, as well as providing release notes that will be added to the changelog upon release.

To create a new changeset, run pnpm changeset. This will run the Changesets CLI, prompting you for details about the change. You’ll be able to edit the file after it’s created — don’t worry about getting everything perfect up front.

Even though you can technically use any markdown formatting you like, headings should be avoided since each changeset will ultimately be nested within a bullet list. Instead, bold text should be used as section headings.

If your PR is making changes to an area that already has a changeset (e.g. there’s an existing changeset covering theme API changes but you’re making further changes to the same API), you should update the existing changeset in your PR rather than creating a new one.

Releasing to npm ​

The first time a PR with a changeset is merged after a release, a new PR will automatically be created called Version Packages. Any subsequent PRs with changesets will automatically update this existing version packages PR. Merging this PR triggers the release process by publishing to npm and cleaning up the changeset files.

Creating a snapshot release ​

If a PR has changesets, you can create a snapshot release by manually dispatching the Snapshot workflow. This publishes a tagged version to npm with the PR branch name and timestamp.

9. Updating dependencies ​

Use Taze by running:

bash
pnpm deps       # prints outdated deps
pnpm deps patch # print outdated deps with new patch versions
pnpm deps -w    # updates deps (best done with clean working tree)