contributing.md

Contributing Guide

We greatly appreciate your willingness to contribute to this project! Before submitting a pull request, there are some guidelines you should notice.

Guidelines

This project is a monorepo using Turborepo, pnpm and Changesets.

Before Submitting

• Check if there's other similar PRs.
• Format your code with pnpm run format.
• Add changesets with pnpm changeset, which documents the changes you've made.
• Run unit tests with pnpm test and update snapshots if necessary.

New Feature

Before submitting a new feature, make sure to open an issue (Feature Request) with sufficient information and reasons about the new feature. After the feature request is approved, you can submit a pull request.

Bug Fixes

Provide a detailed description of the bug (with live demo if possible). OR open a bug report and link it in your PR.

Docs

Contributing to the docs is relatively easier, make sure to check the typos and grammatical mistakes before submitting.

Local Development

Follow the steps below to set up the project locally for development.

Prerequisites

• Node
• pnpm
• Git

Setup

git clone https://github.com/<your-username>/fumadocs.git
cd fumadocs

Install Dependencies

pnpm install

Running the Project

This repository uses Turborepo, so development servers should be started using the --filter option. Before running any app, build all shared packages:

pnpm run build --filter=./packages/*

Then, start docs site in dev mode.

pnpm run dev --filter=docs

Formatting & Linting

pnpm run format
pnpm run lint

Type Checking

pnpm run types:check

Tests

pnpm test

New to contributing?

You may start with contributing to the docs, it is located in /apps/docs/content/docs.

To run the docs site in dev mode, build the dependencies with pnpm run build --filter=./packages/* and run pnpm run dev --filter=docs to start the dev server.

You don't need any extra environment variables to run this project.