CONTRIBUTING.md

Contributing

Tooling

Not all of this is required to contribute, but for the best experience it's recommended you check all of this out.

• asdf
• pnpm
• typescript
• prettier
• eslint
• turborepo
• cypress
• changesets

Getting started

git clone your-fork/notree
pnpm i
pnpm dev

Code style

Feel free to do whatever you want for the most part! We have a few conventions that should be followed:

// "public" (exported) functions should be camel case
export function doCoolStuff(): void;

// "private" functions should be snake case
function helper_function(): number;

// classes should read public (top) to private (bottom)
export class Cat {
  public color: string;
  constructor() {}
  public runAround(): void;
  private mood: number;
  private speak_spanish(): string;
}

Committing changes

This project uses conventional commit messages

Opening a pr

Make sure to run pnpm changeset before opening a pr and using the cli tool to describe your changes.

GitHub will run your changes through a ci pipeline, but you can see if it will pass locally by running pnpm run ci. If you want tests to pass you will need a GitHub token as described by the GitHub provider docs in the read package.