Skip to content
Snippets Groups Projects
Forked from pregmodfan / fc-pregmod
10329 commits behind the upstream repository.
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
CONTRIBUTING.md 5.27 KiB

Contributing to FC: Pregmod

First off, thanks for taking the time to contribute!

If there is anything you don't understand feel free to ask. Many of the more advanced tools are also not required for fixing small typos or simple bugs.

Environment

Requirements

To effectively work on the project the following tools are required:

  • Git
  • Node.js or another npm client
  • an IDE capable of working with JavaScript, TypeScript and CSS. VS Code is one option.
  • Java Runtime Environment, minimum JRE8

Setting everything up

  1. Clone the project from GitGud.io (Detailed Git setup and work cycle)
  2. Open a terminal (Linux) / cmd window (Windows) and navigate to the fc-pregmod root directory.
  3. Run npm install
  4. Open the directory in your preferred IDE
  5. Configure your IDE to use ESLint and the type checking capabilities of the TypeScript compiler.

Compiling