Skip to content

Commit 4a99ec5

Browse files
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 #802 (comment) --------- Co-authored-by: John Wellbelove <[email protected]>
1 parent f5eab49 commit 4a99ec5

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# How to contribute
2+
3+
If your are considering creating a pull request, please observe the following:
4+
5+
- If you are adding or modifying a feature, add *new* unit tests that test that feature.
6+
- If you are fixing a bug, add a unit test that *fails* before the bug fix is implemented.
7+
- Do not initiate a pull request until all of the units tests pass.
8+
- Branches should be based on the branch `master`.
9+
10+
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.

0 commit comments

Comments
 (0)