-
Notifications
You must be signed in to change notification settings - Fork 485
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change to Apache license v.2 and add DCO / CONTRIBUTING.md (#97)
Signed-off-by: Yuri Shkuro <[email protected]>
- Loading branch information
1 parent
b922904
commit 4c8d295
Showing
4 changed files
with
340 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,119 @@ | ||
# Contributing to Jaeger UI | ||
# How to Contribute to Jaeger | ||
|
||
We'd love your help! If you would like to contribute code you can do so through GitHub | ||
by forking the repository and sending a pull request into the `master` branch. | ||
We'd love your help! | ||
|
||
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 | ||
|
||
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 | ||
|
||
*Before making any significant changes, please [open an | ||
issue](https://github.com/uber/jaeger-ui/issues).* Discussing your proposed | ||
issue](https://github.com/jaegertracing/jaeger-ui/issues).* Discussing your proposed | ||
changes ahead of time will make the contribution process smooth for everyone. | ||
|
||
Once we've discussed your changes and you've got your code ready, make sure | ||
that tests are passing and open your pull request. Your PR is most likely | ||
to be accepted if it: | ||
|
||
* Includes tests for new functionality. | ||
* References the original issue in description, e.g. "Fixes #123". | ||
* References the original issue in description, e.g. "Resolves #123". | ||
* Has a [good commit | ||
message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
* Each commit must be 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 [MIT License](LICENSE). | ||
of the [Apache License](LICENSE). | ||
|
||
If you are adding a new file it should have a header like below. | ||
If you are adding a new file it should have a header like below. | ||
|
||
``` | ||
// Copyright (c) 2017 Uber Technologies, Inc. | ||
// Copyright (c) 2017 The Jaeger Authors. | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a copy | ||
// of this software and associated documentation files (the "Software"), to deal | ||
// in the Software without restriction, including without limitation the rights | ||
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
// copies of the Software, and to permit persons to whom the Software is | ||
// furnished to do so, subject to the following conditions: | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// The above copyright notice and this permission notice shall be included in | ||
// all copies or substantial portions of the Software. | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
// THE SOFTWARE. | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
``` | ||
|
||
## 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/)): | ||
|
||
``` | ||
Developer Certificate of Origin | ||
Version 1.1 | ||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
660 York Street, Suite 102, | ||
San Francisco, CA 94110 USA | ||
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 <[email protected]> | ||
|
||
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`. | ||
|
||
If you want this to be automatic you can set up some aliases: | ||
|
||
``` | ||
git config --add alias.amend "commit -s --amend" | ||
git config --add alias.c "commit -s" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
Developer Certificate of Origin | ||
Version 1.1 | ||
|
||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
660 York Street, Suite 102, | ||
San Francisco, CA 94110 USA | ||
|
||
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. | ||
|
Oops, something went wrong.