CONTRIBUTING.md

Contributing to @folks-finance/xchain-sdk

Table of Contents

• Contributing to @folks-finance/xchain-sdk
  • Table of Contents
    • Using nvm to Manage Node.js Version
    • Using pnpm Managed via Corepack
    • Commit Guidelines
    • Changesets and Automated Versioning

Using nvm to Manage Node.js Version

We use nvm (Node Version Manager) to manage the version of Node.js used in this project. The required Node.js version is specified in the .nvmrc file. To ensure you are using the correct version, follow these steps:

1. Install nvm: If you don't have nvm installed, you can install it by following the instructions on the nvm GitHub repository.

2. Activate the Correct Node.js Version:

   nvm install
   nvm use

These commands will read the .nvmrc file and set your Node.js version accordingly. For more detailed instructions and troubleshooting, refer to the nvm documentation.

Using pnpm Managed via Corepack

We use pnpm as our package manager, which is managed via corepack. To get started with pnpm, follow these steps:

1. Enable corepack:

   corepack enable

2. Use pnpm: After enabling corepack, you will be able to use pnpm for managing dependencies and running scripts.

For a more complete guide on installing and using pnpm with corepack, please refer to the pnpm documentation.

Commit Guidelines

We use commitlint to ensure that all commit messages follow the conventional-commit standard. This helps us maintain a clear and consistent commit history.

The best way to make commits is by using the following command:

pnpm commit

This will launch an automated prompt that guides you step by step through writing a commit message according to our conventions.

For more information on the conventional-commit convention, please refer to the Conventional Commits specification.

Changesets and Automated Versioning

All commits must go through pull requests. In every pull request where changes are made that modify the SDK, you have to generate a changeset by launching:

pnpm changeset

This command will guide you through creating a changeset file that describes the changes made in the pull request and specifies the type of version bump required (patch, minor, major).

Package versioning, publishing, and the generation of changelogs on GitHub releases are automated via GitHub Actions. This ensures that the package is always up-to-date and that every change is properly versioned, published, and documented without manual intervention.

For more information on creating and managing changesets, please refer to the Changesets documentation.