Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
113 lines (74 loc) · 5.31 KB

CONTRIBUTING.md

File metadata and controls

113 lines (74 loc) · 5.31 KB
Raw

CONTRIBUTING

Thank you for taking the time to read this and for showing your interest in supporting the project.

There are several ways to contribute, whether you are a programmer or just a fan of this type of game. Any meaningful help is appreciated. This game was born from dissatisfaction with market alternatives and was built by a football fan for football fans.

If you do not code, you can still help in many ways:

  • Give us a star!
  • Join the Discord server: https://discord.gg/2CXaesaukT
  • Tweet about the project!
  • Refer this project in your project's readme!
  • Tell your friends about us!
  • Share us on Facebook!
  • Donate to the project (not available yet)
  • Make a video about it!
  • Play it!

How to contribute

If you really want to help us directly, thank you very much! We have a few jobs that you might be interested in:

  • Report a problem
    You can report bugs or issues you encounter in the game. Open an Issue and follow the steps to report the problem. Please read carefully the bug reporting issue template before submitting a new bug report. Provide as much information as you can to help us track the bug and solve it as fast as we possibly can. If you want to discuss a problem before filing it, you can also join the Discord server: https://discord.gg/2CXaesaukT

  • Propose enhancements
    You can also propose new enhancements or improvements to the game. We're considering new ideas every day, and you can propose yours by opening an Issue and following the steps to propose enhancements. Just make sure to check the Issues page for similar ideas before opening up a new Issue. We don't want to flood the page with duplicated issues. Discord is also a good place for early discussion: https://discord.gg/2CXaesaukT

  • Documentation
    Do you think we can improve our documentation somehow? You can propose changes to the text, or write useful tutorials or examples on how to do certain things in the game.

  • Translation
    Localization contributions are welcome. You can help improve existing translations and add new locales for both the game UI and documentation.

  • Create new content
    You can propose and contribute content for the game, such as images, logos, and database improvements. Please open an Issue first so we can align scope and format.

Submitting code

The most traditional way to contribute is to submit new code. Openfoot Manager is a GPLv3 licensed project, read the LICENSE.md before submitting your code.

Your code must be GPLv3 compliant, which means you understand that any code submitted here is original or also GPL-compliant, and must not depend on patents or copyrighted third-party content. Your code is subject to a free and open source license that will be available to the entire open source community.

Once you understand that concept, you're welcome to submit new code.

Installing dependencies

This project uses Rust for the backend and Node.js/npm for the frontend.

  1. Ensure you have Rust installed.
  2. Ensure you have Node.js (v18+) installed.
  3. Install Tauri prerequisites for your OS following the official Tauri guide.

After cloning the repository, install the frontend dependencies:

npm install

To run the debug version of the project (starts both the Vite server and the Tauri app):

npm run tauri dev

Understanding the code

The backend is split into multiple Rust crates:

  • domain: Pure business logic and models.
  • engine: Match simulation engine.
  • db: Database access and persistence handling.
  • ofm_core: Coordinates state, the game clock, and data flow.

The frontend is built with React, TypeScript, and TailwindCSS in the src/ directory.

Fork and Pull

We work with a Fork & Pull method. Fork this repo, write your code in a feature branch (make sure it is up to date with the develop branch), and open a Pull Request targeting develop, describing your changes and referencing the Issue that inspired your code when applicable.

If you're working on a new feature that has no prior Issue related to it, please open an Issue describing the feature and then reference it in your new Pull Request.

Code conventions

  • Rust:

    • Run cargo fmt to format your Rust code.
    • Run cargo clippy to catch common mistakes and improve code quality. Address all warnings before submitting a PR.
    • Use descriptive variable names and leverage Rust's strong type system.
    • Write docstrings for public functions and complex logic.

  • Frontend (TypeScript/React):

    • Keep components modular.
    • Use TailwindCSS for styling instead of raw CSS where possible.
    • Ensure type safety across the application (avoid any types).

Tests

Whenever you add a new feature (backend or frontend), include tests to ensure it behaves as expected.

Write unit tests in the same file as your code using the #[cfg(test)] module, as is standard in the Rust community.

Run all relevant tests before opening a Pull Request:

npm test
cd src-tauri
cargo test --workspace

If your change affects both layers, run both test suites.