Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 1.83 KB
Raw

Contribution Guidelines

When contributing to this repository, please:

  • Be respectful, civil, and open-minded.
  • First discuss the change you wish to make via issue, email, or any other method with owner of this repository.
  • Be wary that final decisions are made by the repository owner. So to avoid wasting your time, please contact the repository owner before commiting to any major changes.

Pull Request Process

  1. Update the README.md according to the changes you made (roadmap, features, etc.).
  2. Increase the version numbers that this Pull Request would represent. The versioning scheme we use is SemVer.
  3. You may merge the Pull Request in once you have the sign-off from repository owner. You can find repository owner's contacts here if you want to speed up the process.

How to Contribute

Prerequisites

In order to not waste your time implementing a change that has already been declined, or is generally not needed, start by opening an issue, describing the problem you would like to solve.

This project uses pnpm as its package manager. But you may use any other fancy stuff like Bun. Install it if you haven't already:

npm install -g pnpm

Then, install the project's dependencies:

pnpm install

When making commits, make sure to follow the conventional commit guidelines, i.e. prepending the message with feat:, fix:, chore:, docs:, etc... You can use git status to double check which files have not yet been staged for commit:

git add <file> && git commit -m "feat/fix/chore/docs: commit message"

Credits

This document was inspired by the contributing guidelines for t3-oss/create-t3-app.