Skip to content
This repository was archived by the owner on Aug 30, 2022. It is now read-only.

Commit 30f7796

Browse files
AarshiyaGunejayurishkuro
authored andcommitted
Add CONTRIBUTING.md (#65)
* Add CONTRIBUTING.md Signed-off-by: AarshiyaGuneja <[email protected]>
1 parent 463391e commit 30f7796

File tree

2 files changed

+118
-0
lines changed

2 files changed

+118
-0
lines changed

CONTRIBUTING.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# How to Contribute to Jaeger
2+
3+
We'd love your help!
4+
5+
Jaeger is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub
6+
pull requests. This document outlines some of the conventions on development
7+
workflow, commit message formatting, contact points and other resources to make
8+
it easier to get your contribution accepted.
9+
10+
We gratefully welcome improvements to documentation as well as to code.
11+
12+
## Making A Change
13+
14+
*Before making any significant changes, please [open an issue](https://github.com/jaegertracing/cpp-client/issues).*
15+
Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.
16+
17+
Once we've discussed your changes and you've got your code ready, make sure
18+
that tests are passing and open your pull request. Your pull request is most likely to be accepted if it:
19+
20+
* Includes tests for new functionality.
21+
* Follows the code style guidelines.
22+
* Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
23+
* Each commit is signed by the author ([see below](#sign-your-work)).
24+
25+
## License and Certificate of Origin
26+
27+
By contributing to this project you agree to license your contribution under the terms
28+
of the [Apache License](LICENSE), and you agree to the [Developer Certificate of
29+
Origin](https://developercertificate.org/) (DCO). This document was created
30+
by the Linux Kernel community and is a simple statement that you, as a
31+
contributor, have the legal right to make the contribution. See the [DCO](DCO)
32+
file for details.
33+
34+
/*
35+
* Copyright (c) 2018, The Jaeger Authors
36+
*
37+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
38+
* in compliance with the License. You may obtain a copy of the License at
39+
*
40+
* http://www.apache.org/licenses/LICENSE-2.0
41+
*
42+
* Unless required by applicable law or agreed to in writing, software distributed under the License
43+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
44+
* or implied. See the License for the specific language governing permissions and limitations under
45+
* the License.
46+
*/
47+
```
48+
49+
## Sign your work
50+
51+
The sign-off is a simple line at the end of the explanation for the
52+
patch, which certifies that you wrote it or otherwise have the right to
53+
pass it on as an open-source patch. The rules are pretty simple: if you
54+
can certify the below (from
55+
[developercertificate.org](http://developercertificate.org/)):
56+
57+
```
58+
Developer Certificate of Origin
59+
Version 1.1
60+
61+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
62+
660 York Street, Suite 102,
63+
San Francisco, CA 94110 USA
64+
65+
Everyone is permitted to copy and distribute verbatim copies of this
66+
license document, but changing it is not allowed.
67+
68+
69+
Developer's Certificate of Origin 1.1
70+
71+
By making a contribution to this project, I certify that:
72+
73+
(a) The contribution was created in whole or in part by me and I
74+
have the right to submit it under the open source license
75+
indicated in the file; or
76+
77+
(b) The contribution is based upon previous work that, to the best
78+
of my knowledge, is covered under an appropriate open source
79+
license and I have the right under that license to submit that
80+
work with modifications, whether created in whole or in part
81+
by me, under the same open source license (unless I am
82+
permitted to submit under a different license), as indicated
83+
in the file; or
84+
85+
(c) The contribution was provided directly to me by some other
86+
person who certified (a), (b) or (c) and I have not modified
87+
it.
88+
89+
(d) I understand and agree that this project and the contribution
90+
are public and that a record of the contribution (including all
91+
personal information I submit with it, including my sign-off) is
92+
maintained indefinitely and may be redistributed consistent with
93+
this project or the open source license(s) involved.
94+
```
95+
96+
then you just add a line to every git commit message:
97+
98+
Signed-off-by: Joe Smith <[email protected]>
99+
100+
using your real name (sorry, no pseudonyms or anonymous contributions.)
101+
102+
You can add the sign off when creating the git commit via `git commit -s`.
103+
104+
If you want this to be automatic you can set up some aliases:
105+
106+
```
107+
git config --add alias.amend "commit -s --amend"
108+
git config --add alias.c "commit -s"
109+
```

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
# cpp-client
44
C++ OpenTracing binding for Jaeger
55

6+
## Contributing
7+
8+
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
9+
610
## Generated files
711

812
This project uses Apache Thrift for wire-format protocol support code
@@ -21,9 +25,14 @@ The code can be re-generated with
2125
but at time of writing (Thrift 0.11.0) the resulting code is invalid due to
2226
https://issues.apache.org/jira/browse/THRIFT-4484
2327

28+
## License
29+
30+
[Apache 2.0 License](./LICENSE).
31+
2432
[ci-img]: https://travis-ci.org/jaegertracing/cpp-client.svg?branch=master
2533
[ci]: https://travis-ci.org/jaegertracing/cpp-client
2634
[cov-img]: https://codecov.io/gh/jaegertracing/cpp-client/branch/master/graph/badge.svg
2735
[cov]: https://codecov.io/gh/jaegertracing/cpp-client
2836
[ot-img]: https://img.shields.io/badge/OpenTracing--1.0-enabled-blue.svg
2937
[ot-url]: http://opentracing.io
38+

0 commit comments

Comments
 (0)