Skip to content

Commit

Permalink
Merge branch 'master' into add-cmd-flags-hotrod-ports
Browse files Browse the repository at this point in the history
  • Loading branch information
@cboornaz17
cboornaz17 authored Jul 24, 2018
2 parents 8cef0fe + df4a5e0 commit 85d487f
Showing 1 changed file with 90 additions and 61 deletions.
151 changes: 90 additions & 61 deletions CONTRIBUTING_GUIDELINES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,51 +2,59 @@

We'd love your help!

Jaeger is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub
Jaeger is [Apache 2.0 licensed](./LICENSE) and accepts contributions via GitHub
pull requests. This document outlines some of the conventions on development
workflow, commit message formatting, contact points and other resources to make
it easier to get your contribution accepted.

We gratefully welcome improvements to documentation as well as to code.

# Certificate of Origin
Table of Contents:

By contributing to this project you agree to the [Developer Certificate of
Origin](https://developercertificate.org/) (DCO). This document was created
by the Linux Kernel community and is a simple statement that you, as a
contributor, have the legal right to make the contribution. See the [DCO](DCO)
file for details.
* [Making a Change](#making-a-change)
* [License](#license)
* [Sign your work](#sign-your-work)

## Making A Change
## Making a Change

**Before making any significant changes, please open an issue**. Each issue
should describe the following:

*Before making any significant changes, please open an
issue.* Each issue should describe the following:
* Requirement - what kind of business use case are you trying to solve?
* Problem - what in Jaeger blocks you from solving the requirement?
* Proposal - what do you suggest to solve the problem or improve the existing situation?
* Proposal - what do you suggest to solve the problem or improve the existing
situation?
* Any open questions to address

Discussing your proposed changes ahead of time will make the contribution process smooth for everyone. Once the approach is agreed upon, make your changes and open a pull request (PR). Each PR should describe:
* Which problem it is solving. Normally it should be simply a reference to the corresponding issue, e.g. `Resolves #123`.
Discussing your proposed changes ahead of time will make the contribution
process smooth for everyone. Once the approach is agreed upon, make your changes
and open a pull request (PR). Each PR should describe:

* Which problem it is solving. Normally it should be simply a reference to the
corresponding issue, e.g. `Resolves #123`.
* What changes are made to achieve that.

Your pull request is most likely to be accepted if **each commit**:
* Has a [good commit message](https://chris.beams.io/posts/git-commit/). In summary:
* Separate subject from body with a blank line
* Limit the subject line to 50 characters
* Capitalize the subject line
* Do not end the subject line with a period
* Use the imperative mood in the subject line
* Wrap the body at 72 characters
* Use the body to explain _what_ and _why_ instead of _how_

* Has a [good commit message][good-commit-msg]. In summary:
* Separate subject from body with a blank line
* Limit the subject line to 50 characters
* Capitalize the subject line
* Do not end the subject line with a period
* Use the imperative mood in the subject line
* Wrap the body at 72 characters
* Use the body to explain _what_ and _why_ instead of _how_
* Has been signed by the author ([see below](#sign-your-work)).

## License

By contributing your code, you agree to license your contribution under the terms
of the [Apache License](LICENSE).
By contributing your code, you agree to license your contribution under the
terms of the [Apache License](./LICENSE).

If you are adding a new file it should have a header like below. In some languages, e.g. Python, you may need to change the comments to start with `#`. The easiest way is to copy the header from one of the existing source files and make sure the year is current and the copyright says "The Jaeger Authors".
If you are adding a new file it should have a header like below. In some
languages, e.g. Python, you may need to change the comments to start with `#`.
The easiest way is to copy the header from one of the existing source files and
make sure the year is current and the copyright says "The Jaeger Authors".

```
// Copyright (c) 2018 The Jaeger Authors.
Expand All @@ -66,55 +74,76 @@ If you are adding a new file it should have a header like below. In some languag

## Sign your work

The sign-off is a simple line at the end of the explanation for the
patch, which certifies that you wrote it 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/)):
By contributing to this project you agree to the
[Developer Certificate of Origin](https://developercertificate.org/) (or simply
[DCO](./DCO)). This document was created by the Linux Kernel community and is a
simple statement that you, as a contributor, have the legal right to make the
contribution.

```
Developer Certificate of Origin
Version 1.1
The sign-off is a simple line at the end of the explanation for the patch, which
certifies that you wrote it or otherwise have the right to pass it on as an
open-source patch. The rules are pretty simple: if you can certify the
conditions in the [DCO](./DCO), then just add a line to every git commit
message:

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA
Signed-off-by: Bender Bending Rodriguez <[email protected]>

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
using your real name (sorry, no pseudonyms or anonymous contributions.) You can
add the sign off when creating the git commit via `git commit -s`.

### Missing sign-offs

Developer's Certificate of Origin 1.1
Note that **every commit in the pull request must be signed**. Jaeger
repositories are configured with a [DCO-bot][dco-bot] that will check sign-offs
on every commit and block the PR from being merged if some commits are missing
sign-offs. If you only have one commit or the latest commit in the PR is missing
a sign-off, the simplest way to fix this is to run:

By making a contribution to this project, I certify that:
```
git commit --amend -s
```

which will prompt you to edit the commit message while adding a signature.
Simply accept the text as is, and push the branch:

```
git push --force
```

(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
If some commit in the middle of your commit history is missing the sign-off, the
simplest solution is to squash the commits into one and sign it. For example,
suppose that your branch history looks like this:

(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
```
fe43631 - Fix HotROD Docker command
933efb3 - Add files for ingester
214c133 - Rename gas to gosec
0a40309 - Update Makefile build_ui target to lerna structure
7919cd9 - Add support for Cassandra reconnect interval
a0dc40e - Fix deploy step
77a0573 - (tag: v1.6.0) Prepare release 1.6.0
```

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
Let's assume that the first commit `77a0573` was the commit before you started
work on your PR, and commits from `a0dc40e` to `fe43631` are your changes that
you want to squash. You can run the soft reset command:

(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.
```
git reset --soft 77a0573
```

then you just add a line to every git commit message:
It will undo all changes after commit `77a0573` and stage them. You can commit
them all at once while adding the signature:

Signed-off-by: Joe Smith <[email protected]>
```
git commit -s -m 'your commit message, e.g. the PR title'
```

Then push the branch:

using your real name (sorry, no pseudonyms or anonymous contributions.)
```
git push --force
```

You can add the sign off when creating the git commit via `git commit -s`.
[good-commit-msg]: https://chris.beams.io/posts/git-commit/
[dco-bot]: https://github.com/probot/dco#how-it-works

0 comments on commit 85d487f

Please sign in to comment.