Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (39 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

62 lines (39 loc) · 3.76 KB
Raw

Contributor's Guide

Thank you for taking the time to contribute!

Any contributions to this project are welcome and encouraged, regardless of programming expertise. If you're not sure where to start or how contributing works, you can refer to these articles which may give you some useful pointers and insights.

For Users

Before you jump the gun, we ask that you first and foremost check the following feeds to see if your issue has already been addressed or resolved:

If you issue has already been listed, you're welcome to add a comment if you have any additional context to contribute!

When creating a new issue, please use the corresponding templates to better organize the context surrounding your issue and make it as easy as possible for maintainers to address your issue in a timely manner.

For Developers

This project is bootstrapped with a modified Vite + React + TypeScript template.

Prerequisites

Project Setup

The documentation site has a very detailed guide on how to build the web application on your local machine.

Once you have a local copy of the project on your machine, we'd recommend taking these additional steps before you start making any code modifications:

  1. Create a new fork of the repository, so that all of your modifications can be tracked on your copy of the repository.
  2. Create a new dedicated branch for your changes and sync it to your workspace.

Git Hooks

Pre-commit hooks are configured via lefthook to run linters/formatters automatically before making commits to the repository.

These hooks are not enabled by default, but you can run lefthook install to enable them for your workspace.

Submitting a Pull Request

If you think you're ready to make a pull request, be sure to run through the following checklist to ensure your code is production-ready:

  • If you did not activate the available git hooks for your workspace, run the following command to manually run the linter/formatter on your changes: biome check --write {files}.
  • Run vitest run to ensure all unit tests are passing.
  • Make a production build for your application (vite build && vite preview) and ensure your changes are stable and no critical errors are present.

Once submitted, a maintainer will review your pull request and, once approved, integrate your changes into a staging branch for future release.

Important

While we don't explicitly forbid the use of LLMs when submitting contributions, we do expect you to take full responsibility for all changes submitted within your pull request, which includes acknowlegement of the following:

  • Ensuring all changes match the general standards and practices of the current codebase
  • Performing a manual audit of all changes to ensure there are no critical regressions or security issues
  • Making any requested changes in a cordial and timely manner

Any attempt to subvert these expectations or otherwise mislead maintainers may result in your pull request being closed without further review and/or disciplinary action if deemed necessary.