Getting Started

Set up your development environment and start contributing to Attributes

We’re excited to have you here! This guide will help you get your development environment set up so you can start contributing to the Attributes project.

If you’re new to open source, you might want to check the Open Source Guides website for some great resources on how to get started.

Prerequisites

Before you begin, ensure you have pnpm installed on your system. Attributes uses pnpm as its package manager for the monorepo setup.

Installation

1. Fork and Clone the Repository

First, fork the repository on GitHub, then clone your fork:

git clone https://github.com/YOUR_USERNAME/attributes.git
cd attributes

2. Install Dependencies

After cloning the repository, install all dependencies using pnpm:

pnpm install

This will install all dependencies for all packages in the monorepo.

Development Workflow

Start the Development Server

You can start a local development server with:

pnpm dev

This will compile the library and watch for changes. The library will be available at http://localhost:3000/attributes.js.

Running Tests

Run all tests with:

pnpm test

For headed mode (with visible browser):

pnpm test:headed

Linting and Type Checking

Always lint and typecheck your code before submitting a pull request:

pnpm lint
pnpm check

To automatically fix linting issues:

pnpm lint:fix

Building the Project

To build the entire project:

pnpm build

Getting Help

If you have questions about using Attributes, please use the Finsweet forum. The issue list of this repository is exclusively for bugs and feature requests.

Next Steps

Now that you have your development environment set up, you can:

• Learn about the monorepo architecture
• Read the testing guide
• Review the pull request guidelines