Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

24 lines (18 loc) · 1.66 KB

Contributing to the Hanab Live Project

With issues:

  • Use the search tool before opening a new issue.

With pull requests:

  • We hang out in the Discord server in the #website-development channel. Come say hi.
  • Your pull requests need to pass the linter. To set up the linter, read and follow the installation instructions.
  • Help me fix all these bugs and issues!

Creating a New Variant

  • First, create a GitHub issue to discuss how the variant should work and if it should be implemented at all.
  • Next, create the variant on your local computer by following the below steps.
  • If your variant adds new suits into the game, modify "suits.json" and add them at the end.
  • You do not have to manually change "variants.json" or "variants.txt", as those files are automatically created by the "create-variants-json" script.
  • Instead, find the file "getVariantDescriptions.ts" and look for the "variantDescriptions" variable. This contains the functions that create each variant. You need to create a new function and add it to this list. (You can use an existing function as a template.)
  • Note that the clue color palate will add clue colors from left to right for the variant in the order that the suits are listed for that variant.
  • Once your modifications are complete, run npm run create-variants-json to create a new version of "variants.json" and "variants.txt". (The "variants.json" file is used by the server as the list of allowed variant combinations.)
  • Run a test game to make sure everything in the new variants work as intended.
  • Run "./lint.sh" to make sure that your changes pass the linter.
  • Submit a pull request.