-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add license, contributing, fix coverage script (#2)
- Loading branch information
1 parent
66ef10f
commit 1071221
Showing
9 changed files
with
236 additions
and
7 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 |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Contributing 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. | ||
|
||
## Getting Started | ||
|
||
This library uses [glide](https://github.com/Masterminds/glide) to manage dependencies. | ||
|
||
To get started: | ||
|
||
```bash | ||
git submodule update --init --recursive | ||
glide install | ||
make test | ||
``` | ||
|
||
## Making A Change | ||
|
||
*Before making any significant changes, please [open an | ||
issue](https://github.com/uber/jaeger/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 (`make test` or `make cover`) and open your PR! Your | ||
pull request is most likely to be accepted if it: | ||
|
||
* Includes tests for new functionality. | ||
* Follows the guidelines in [Effective | ||
Go](https://golang.org/doc/effective_go.html) and the [Go team's common code | ||
review comments](https://github.com/golang/go/wiki/CodeReviewComments). | ||
* Has a [good commit | ||
message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
|
||
## License | ||
|
||
By contributing your code, you agree to license your contribution under the terms | ||
of the MIT License: https://github.com/uber/jaeger/blob/master/LICENSE | ||
|
||
If you are adding a new file it should have a header like below. | ||
|
||
``` | ||
// Copyright (c) 2016 Uber Technologies, Inc. | ||
// | ||
// 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: | ||
// | ||
// The above copyright notice and this permission notice shall be included in | ||
// all copies or substantial portions of the Software. | ||
// | ||
// 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. | ||
``` | ||
|
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,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2016 Uber Technologies, Inc. | ||
|
||
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: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
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. |
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
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
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
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
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,88 @@ | ||
from __future__ import ( | ||
absolute_import, print_function, division, unicode_literals | ||
) | ||
|
||
import re | ||
import sys | ||
from datetime import datetime | ||
|
||
CURRENT_YEAR = datetime.today().year | ||
|
||
LICENSE_BLOB = """Copyright (c) %d Uber Technologies, Inc. | ||
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: | ||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
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.""" % CURRENT_YEAR | ||
|
||
LICENSE_BLOB_LINES_GO = [ | ||
('// ' + l).strip() + '\n' for l in LICENSE_BLOB.split('\n') | ||
] | ||
|
||
COPYRIGHT_RE = re.compile(r'Copyright \(c\) (\d+)', re.I) | ||
|
||
|
||
def update_go_license(name): | ||
with open(name) as f: | ||
orig_lines = list(f) | ||
lines = list(orig_lines) | ||
|
||
found = False | ||
changed = False | ||
for i, line in enumerate(lines[:5]): | ||
m = COPYRIGHT_RE.search(line) | ||
if not m: | ||
continue | ||
|
||
found = True | ||
year = int(m.group(1)) | ||
if year == CURRENT_YEAR: | ||
break | ||
|
||
new_line = COPYRIGHT_RE.sub('Copyright (c) %d' % CURRENT_YEAR, line) | ||
assert line != new_line, ('Could not change year in: %s' % line) | ||
lines[i] = new_line | ||
changed = True | ||
break | ||
|
||
if not found: | ||
if 'Code generated by' in lines[0]: | ||
lines[1:1] = ['\n'] + LICENSE_BLOB_LINES_GO | ||
else: | ||
lines[0:0] = LICENSE_BLOB_LINES_GO + ['\n'] | ||
changed = True | ||
|
||
if changed: | ||
with open(name, 'w') as f: | ||
for line in lines: | ||
f.write(line) | ||
print(name) | ||
|
||
|
||
def main(): | ||
if len(sys.argv) == 1: | ||
print('USAGE: %s FILE ...' % sys.argv[0]) | ||
sys.exit(1) | ||
|
||
for name in sys.argv[1:]: | ||
if name.endswith('.go'): | ||
update_go_license(name) | ||
else: | ||
raise NotImplementedError('Unsupported file type: %s' % name) | ||
|
||
|
||
if __name__ == "__main__": | ||
main() |
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,6 @@ | ||
#!/bin/bash | ||
|
||
set -e | ||
#set -x | ||
|
||
python scripts/updateLicense.py $(go list -json $(glide nv) | jq -r '.Dir + "/" + (.GoFiles | .[])') |
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