Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
144 lines (91 loc) · 4.8 KB

CONTRIBUTING.md

File metadata and controls

144 lines (91 loc) · 4.8 KB
Raw

Contributing

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

If you want to contribute, but aren't sure where to start, you can create a new discussion.

Note

Please ask first before starting work on any significant new features.

It's never a fun experience to have your pull request declined after investing time and effort into a new feature. To avoid this from happening, we request that contributors create a feature request to first discuss any API changes or significant new ideas.

Basic Guide

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

  1. Cloning the repository
  2. Installing Bun
  3. Installing dependencies
  4. Writing documentation
  5. Submitting a pull request
  6. Versioning

Cloning the repository

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

git clone https://github.com/mutuals-finance/mutuals.git

Or the GitHub CLI:

gh repo clone mutuals-finance/mutuals

Installing Bun

Mutuals uses Bun.

You can run the following commands in your terminal to check your local Bun version:

bun -v

If the version ist not correct, or you don't have Bun installed, download and follow their setup instructions:

Installing dependencies

Once in the project's root directory, run the following command to install the project's dependencies:

bun install

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

Writing documentation

Documentation is crucial to helping developers of all experience levels. The documentation site is (located at ./apps/docs). To start the site in dev mode, run:

# FROM: ./

bun run 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.

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, CircleCI 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 CirleCI UI to find the cause.

Versioning

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

Note

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

Each changeset defines which package(s) 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 bun run 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.


✅ Now you're ready to contribute to Mutuals!