Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.2 KB

Contributing

Welcome! We're glad you're interested in contributing to the project.

We welcome contributions of any kind; however, for feature changes or additions, please open an issue first for discussion.

Getting Started

  1. Fork this repository to your GitHub account. You can then clone the repository to your local machine and create a new branch for your changes. 
    git clone https://github.com/[your-username]/varo.dev.git
cd varo.dev
git checkout -b my-feature-branch
  2. Follow the setup guide from the README to install the necessary dependencies and run the development server.
  3. You may now make your changes and commit them to your branch.

Formatting and linting

We use ESLint and Prettier to enforce code style and formatting. Please make sure to run pnpm format and pnpm lint before committing your changes.

Guidelines

  • Follow the Code of Conduct.
  • Make sure your changes are thoroughly tested.
  • Keep your commits atomic and descriptive.
  • Ensure that your code is formatted and linted using pnpm lint:fix.
  • Make your pull requests as descriptive as possible.