Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.53 KB
Raw

Hyoka contributions Guide

Hello and welcome to Hyoka! We're excited that you're interested in contributing to Hyoka. This document is a guide to help you get started.

Package Manager

Hyoka uses pnpm as its package manager. If you don't have pnpm installed, you can install it using the following command:

npm install -g pnpm

How to Contribute

Hyoka is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Hyoka itself. to get started, take a look at the issues page.

Pull Request Guidelines

Before you submit a pull request, please make sure the following is done:

  • Fork the repository and create your branch from master.
  • add your changes to the source code.
  • add tests for your changes if applicable.
  • commit your changes and push your branch to GitHub.
  • open a pull request.

Commit Messages

commit messages should follow the conventional commits specification. we recommend using commitizen to help you write commit messages that follow the specification.

Note on Dependencies

Hyoka aims to be a lightweight library. This includes being aware of the number of dependencies and their size. If you think a dependency is necessary, please open an issue to discuss it.