From 8ad34dc4c238fa5df6a0a510dffe345e7adb015f Mon Sep 17 00:00:00 2001 From: Mike Andrasak Date: Fri, 27 Sep 2019 12:44:52 -0400 Subject: [PATCH] DCO Signoff Updates Signed-off-by: Mike Andrasak --- CONTRIBUTING.md | 7 +++++++ README.md | 11 +++++++---- 2 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..28f7bc30 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,7 @@ +# Contributing +The boost repository requires DCO signing. +By adding a signed off line to your commit, you verify the following, [Developer Certificate of Origin](https://developercertificate.org). + +You can add the signed off line to your commit by adding the -s flag to the git commit command. + +If you'd like to automatically sign off all of your commits you can add a prepare-commit-msg hook to do so. A good example can be found in the [Git prometheus](https://github.com/prometheus/prometheus/wiki/DCO-signing) repository DCO wiki entry at the bottom of the page. diff --git a/README.md b/README.md index 021f5289..26729221 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Boost includes a Maven and Gradle plugin to make it easier to build your MicroProfile applications. -There are two, separate active Boost projects. +There are two, separate active Boost projects. - Boost Maven Plugin, BOMs, and Boosters (`boost-maven`) - Boost Common Resources (`boost-common`) @@ -21,11 +21,15 @@ To see an example of Boost in use in a maven application project, please see our If you are interested in contributing to Boost, read the [wiki](https://github.com/MicroShed/boost/wiki) for more information. +All contributions require a DCO signoff, details of which can be found +[here](CONTRIBUTING.md) + If you are interested in the Boost runtime adapter SPI, it is described in greater detail in the [Boost Runtimes Adapter SPI](https://github.com/MicroShed/boost/wiki/Boost-Runtime-Adapter-SPI) page of the wiki. -git + + ### Building Boost -You will need to build the `boost-common` project before building the `boost-maven` project. We provide some scripts below to simplify this process. +You will need to build the `boost-common` project before building the `boost-maven` project. We provide some scripts below to simplify this process. #### Boost Maven Plugin @@ -42,4 +46,3 @@ To build the Boost Maven Plugin: ``` ./boost-maven.sh ``` -