Skip to content

Commit

Permalink
Added basic guidelines for contributing code (#976)
Browse files Browse the repository at this point in the history
* 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 <jwellbelove@users.noreply.github.com>
  • Loading branch information
dhebbeker and jwellbelove authored Nov 24, 2024
1 parent f5eab49 commit 4a99ec5
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 4a99ec5

Please sign in to comment.