Skip to content
This repository was archived by the owner on Mar 29, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

聽

History

History
60 lines (38 loc) 路 1.26 KB

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) 路 1.26 KB
Raw

Contributing

Thank you for considering contributing to apr 馃榾! We welcome contributions from everyone. By participating in this project, you agree to abide by our Code of Conduct.

Setting Up the Development Environment

  1. Fork the Project

  2. Create a new branch for your changes:

    git checkout -b my-feature-branch

  3. Install the dependencies:

    bun install

Bun runtime

If you don't have Bun installed, you can install it using this command:

Windows

powershell -c "irm bun.sh/install.ps1 | iex"

Linux, macOS, Windows (WSL)

curl -fsSL bun.sh/install | bash

Running Tests and Building the Project

To run the tests, use the following command:

bun run test

To build the project, use the following command:

bun run build

Submitting Pull Requests

  1. Commit your Changes (git commit -m 'Add some AmazingFeature')

  2. Push your branch to your fork:

    git push origin my-feature-branch

  3. Open a Pull Request on GitHub and provide a description of your changes.