Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

24 lines (16 loc) · 1.6 KB
Raw

Contributing to Our Project

Thank you for investing your time in contributing to our project! This document outlines the guidelines and expectations for contributing to our project.

Reporting Bugs or Requesting Features

If you have found a bug in our project or would like to request a new feature, please open an issue on our repository. Before raising an issue, please check to see if there is already an existing issue that covers the same topic.

Contributing Code

If you'd like to contribute code to our project, please follow these steps:

  1. Comment on the issue you'd like to work on (or open a new issue if there isn't one yet) to let us know you're interested in working on it.
  2. Make sure you have NODE=16.14.0 and pnpm=8.6 installed on your local machine (or docker/VM) before running the dev server. To know how to run the dev server please refer to README.md.
  3. We use .eslintrc.js and .prettierrc to lint and format the code, so please make sure your code adheres to these standards.
  4. We recommend using VSCode & Volar for development.
  5. Use conventional commits to write your commit message.
  6. Open a branch to commit your changes, using feat/, fix/, refactor/ prefix to name your branch.
  7. For contributing test case, we currently have end-to-end testing installed with playwright, checkout the test commands in README.md.

Getting Help

If you need help or have questions while contributing to our project, please file an issue on our repository.

Thank you for your contributions! We appreciate your help in making our project better.