coffee/etl
1
0
Fork 0
mirror of https://github.com/ETLCPP/etl.git synced 2026-04-30 19:09:10 +08:00
Code Issues Packages Projects Releases Wiki Activity
etl/CONTRIBUTING.md
David Hebbeker 328a685cee Added basic guidelines for contributing code (#976) 
* Update README.md

* Apply instructions for pull requests from Slack to new CONTRIBUTING guideline file.

I copied the [message in Slack](https://etlcpp.slack.com/archives/C7SJ45VFB/p1729596737002559) from @jwellbelove into a new file for [contributing guidelines](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors). This way a starting point for potential contributors is delivered next to the source code.

* Added hint for the starting point for contributing commits.

I derived this rule from https://github.com/ETLCPP/etl/issues/802#issuecomment-2323530862

---------

Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>
2024-12-19 14:30:28 +00:00

545 B
Raw Blame History

How to contribute

If your are considering creating a pull request, please observe the following:

  • 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.
  • Branches should be based on the branch master.

There is a project file for VS2022 for C++14, 17, 20, and bash scripts that run the tests for C++11, 14, 17, 20 under Linux with GCC and Clang.