From 4a99ec5d63a9a6a35d7eaedb28944cb3c8af1a4f Mon Sep 17 00:00:00 2001 From: David Hebbeker Date: Sun, 24 Nov 2024 16:09:57 +0100 Subject: [PATCH] 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 --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..56ce976d6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# 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.