Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (41 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 1.53 KB

Contributing to tacview-filter

Thank you for your interest in contributing to tacview-filter! We welcome contributions from everyone.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Create a new branch from main for your feature or bug fix.
  4. Make your changes.
  5. Run tests to ensure no regressions.
  6. Push your changes to your fork.
  7. Submit a Pull Request against main.

Reporting Bugs

If you find a bug, please create an issue on GitHub. Include:

  • A descriptive title.
  • Steps to reproduce the issue.
  • Expected behavior vs. actual behavior.
  • The ACMI file(s) involved (or a minimal sample that reproduces the issue).
  • Relevant logs or screenshots.
  • Your operating system and tacview-filter version.

Suggesting Enhancements

We welcome feature requests! Please create an issue on GitHub describing your idea and why it would be useful.

Development

Prerequisites

  • CMake 3.20+
  • C++20 compatible compiler (GCC 10+, Clang 10+, MSVC 2019+)
  • Ninja (recommended)

Building

cmake --preset ninja-debug
cmake --build --preset ninja-debug

Testing

ctest --preset ninja-debug

Code Style

We use clang-format to maintain a consistent code style. Please run the formatter before submitting your changes:

cmake --build --preset ninja-debug --target format

License

By contributing to tacview-filter, you agree that your contributions will be licensed under the GNU General Public License v3.0 or later (GPL-3.0-or-later).