Skip to content
This repository has been archived by the owner on Oct 14, 2020. It is now read-only.

Add DCO signoff instructions #402

Merged
merged 1 commit into from
Oct 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand All @@ -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

Expand All @@ -42,4 +46,3 @@ To build the Boost Maven Plugin:
```
./boost-maven.sh
```