Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 2.59 KB

contributing.md

File metadata and controls

91 lines (61 loc) · 2.59 KB

Contributing

Before getting started

Thank you for contributing to our project!

First of all, we would like to extend our heartfelt thanks to all members of the community who have contributed their time, expertise, and support to this project. Whether you've reported a bug, suggested a feature, or submitted code, your contributions have made a significant impact, and we are truly grateful for all your efforts.

In case you want to talk about the project, or perhaps there are some questions, ideas, or concerns, do not hesitate to reach out to us. We are here to support you and ensure that your contributions are acknowledged and appreciated.

How to contribute

Introduce into dev environment

Dependencies

  • We use git as our version control system.

  • In the project we have the yarn package manager.

  • NodeJS version 18.18 works fine. In case you use a lower version and the project works, let us know.

Preparing a local project instance

  • Make a new fork based on main branch.
  • Clone the fork locally.
git clone https://github.com/<username>/hc-scoreboardui.git
  • Go to the local project directory. Default:
cd hc-scoreboardui
  • Install dependencies
yarn

Commands

Command dev starts watching mode. The mode rebuilds the mjs output script when package modules are changed.

yarn dev

To watch changes in the game use:

yarn dev:game

And then after the build, in the game console refresh the resource with this UI.

ensure qbx_scoreboard --for qbx

If you need further guidance, you can reach out our team on the following:

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

Getting started

For further guidance about getting started, please refer to the related links:

Coding conventions

In order to sanitize coding standards, please follow our eslint recommendations.