etl/CONTRIBUTING.md
Roland Reichwein 89284de733
Add treefmt support (#1323)
Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>
2026-03-13 00:11:51 +00:00

1.3 KiB
Raw Permalink Blame History

How to contribute

Thanks for considering a contribution! Heres what you need to know before opening a pull request:

  • If you are adding or modifying a feature, add new unit tests that test that feature.
  • If you are fixing a bug, add a unit test that fails before the bug fix is implemented.
  • Do not initiate a pull request until all of the units tests pass. See below for information on project files and test scripts.
  • Branches should be based on the branch master. If development has pending updates, Ill rebase the PR against it before pulling..
  • For formatting help, you can use clang-format, or the convenience wrapper treefmt. See also docs/source-formatting.md

There is a project file for VS2022 for C++14, 17, 20, 23, and bash scripts that run the tests for C++11, 14, 17, 20, 23 under Linux with GCC and Clang. There are syntax-only check bash scripts that cover C++03, 11, 14, 17, 20, 23 under Linux with GCC and Clang.

If you are thinking of adding a new feature then raise this on the GitHub Issues page for discussion as the maintainers and user of the ETL may have questions or suggestions. It is possible that the maintainer of the ETL or another contributor is already working on the same or a related feature.

Take a look through our current issues and see if anything sparks your interest!