Skip to content

Commit

Permalink
Merge pull request #1 from duglin/initalSpec
Browse files Browse the repository at this point in the history
initial spec
  • Loading branch information
Doug Davis authored Dec 14, 2017
2 parents f47997f + 4f22b8b commit 18aad14
Show file tree
Hide file tree
Showing 2 changed files with 532 additions and 0 deletions.
90 changes: 90 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Contributing to OpenEventing

This page contains information about reporting issues, how to suggest changes
as well as the guidelines we follow for how our documents are formatted.

## Table of Contents
* [Reporting an Issue](#reporting-an-issue)
* [Suggesting a Change](#suggesting-a-change)
* [Spec Formatting Conventions](#spec-formatting-conventions)

## Reporting an Issue

To report an issue, or to suggest an idea for a change that you haven't
had time to write-up yet, open an
[issue](https://github.com/openeventing/spec/issues). It is best to check
our existing [issues](https://github.com/openeventing/spec/issues) first
to see if a similar one has already been opened and discussed.

## Suggesting a Change

To suggest a change to to this repository, submit a [pull
request](https://github.com/openeventing/spec/pulls)(PR) with the complete
set of changes you'd like to see. See the
[Spec Formatting Conventions](#spec-formatting-conventions) section for
the guidelines we follow for how documents are formatted.

Each PR must be signed per the following section.

### Sign your work

The sign-off is a simple line at the end of the explanation for the patch. Your
signature certifies that you wrote the patch or otherwise have the right to pass
it on as an open-source patch. The rules are pretty simple: if you can certify
the below (from [developercertificate.org](http://developercertificate.org/)):

```
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
```

Then you just add a line to every git commit message:

Signed-off-by: Joe Smith <joe.smith@email.com>

Use your real name (sorry, no pseudonyms or anonymous contributions.)

If you set your `user.name` and `user.email` git configs, you can sign your
commit automatically with `git commit -s`.

## Spec Formatting Conventions

Documents in this repository will adhere to the following rules:
* Lines are wrapped at 80 columns (when possible)
* Specifications will use [RFC2119](https://tools.ietf.org/html/rfc2119)
keywords to indicate normative requirements

Loading

0 comments on commit 18aad14

Please sign in to comment.