CONTRIBUTING.md

Contributing to LichtFeld Studio

Thanks for your interest in contributing!

Getting Started

1. Find an Issue or Propose an Extension

   • Check issues labeled good first issue for newcomers
   • Browse other open issues that interest you
   • Want to add a feature? Open an issue to discuss it first
   • Not sure where to start? Ask on Discord

2. Setup

   • Installation instructions are in the Wiki
   • Install the pre-commit hook: cp tools/pre-commit .git/hooks/

3. Make Your Changes

   • Apply clang-format before committing
   • Write clear commit messages
   • Test your changes

4. Submit a Pull Request

   • Link related issues
   • Describe what you changed and why

Code Style

• Use clang-format for formatting
• Follow C++23 standards
• Add SPDX headers to new files:

  /* SPDX-FileCopyrightText: 2025 LichtFeld Studio Authors
   *
   * SPDX-License-Identifier: GPL-3.0-or-later */

Need Help?

• Join our Discord for questions and discussions
• Check the Wiki for documentation
• Look at the FAQ

License

Contributions are licensed under GPLv3.