etl/CONTRIBUTING.md
Roland Reichwein 9757860241
Remove advance() on static spans (#1281)
* Remove AppVeyor build status badge

Removed AppVeyor build status badge from README.

* Update README.md

* Update CONTRIBUTING.md

Updated the instructions for contributing.

* Fix for issue 1276 "Data corruption in the etl::bip_buffer_spsc_atomic" (#1277)

* Reproduce data corruption bug in the `etl::bip_buffer_spsc_atomic`.

* Fix data corruption bug in the `etl::bip_buffer_spsc_atomic`.

* Remove advance() on static spans

Since the size of a static span is constant, we can't reasonably
advance() on it.

---------

Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>
Co-authored-by: Sergei <sergej.shirokov@gmail.com>
2026-01-23 19:33:08 +01:00

1.2 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..

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!