Skip to content

Contributing

Bug reports, fixes and new real-world parts are welcome. Lothal is a one-person project, so replies may be slow, but every issue and pull request gets read. The full rules are in CONTRIBUTING.md.

The roadmap, what is planned, in progress and done, is public on Kriya. Check it before starting something big.

Open a GitHub issue and include:

  • your operating system and its version;
  • the Lothal version, or the commit if you built from source;
  • what you did, what you expected, and what happened;
  • the log, if there is one. It is in the logs folder of Lothal’s data folder; see Where files live.
  • Keep it small and about one thing.
  • Run the test suite before you open it. Every check must pass. See Build from source.
  • Say in the description what changed and why.

Adding a real part to data/parts/ is a good first pull request. Every number needs a source that says where it came from. See Adding a part.

By contributing you agree your contribution is licensed under GPL-3.0-or-later, and you grant Ritwik Singh a perpetual, irrevocable right to also relicense it under other terms. The exact wording is in CONTRIBUTING.md.

Documentation licensed underCC BY 4.0. Lothal itself is GPL-3.0-or-later.Report a problem.Roadmap.