Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 2.19 KB

Contributing

Thank you for your interest in this project! Please contribute according to the following guidelines:

Please note we have a code of conduct, please follow it in all your interactions with the project.

Development environment setup

To set up a development environment, please follow these steps:

1. Fork this repository and clone it

  1. Fork this repository to your own GitHub account
  2. Clone it to your local device.

2. Prerequisites

  • Bun (Version: >= 1.1.17)

3. Set up your .env file

  1. Duplicate .env.example to .env.
  2. Please set the environment variables in the .env file.

4. Install dependencies

bun install

5. Start developing and watch for code changes

bun dev

Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? Take a look at GitHub Discussions to see if it's already being discussed. You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a Single Bug. One bug per report.

Even better: Submit a pull request with a fix or new feature!

How to submit a Pull Request

  1. Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate effort.
  2. Fork the project
  3. Create your feature branch (git switch -c feat/amazing_feature)
  4. Commit your changes (git commit -m 'feat: add amazing_feature')
  5. Push to the branch (git push origin feat/amazing_feature)
  6. Open a Pull Request