Skip to content

Commit 018e139

Browse files
tomerdtomerd
authored
update copyrights note (swift-server#125)
motivation: the Swift Server Workgroup is not a legal entity and cannot hold copyrights. with this change, code authors continue and retain their copyrights under the apache license and previous copyrights note, but Apple steps up instead of the workgroup which has no legal status changes: * update header files to say "Apple Inc. and the AsyncHTTPClient project authors" instead of "Swift Server Workgroup and the AsyncHTTPClient project authors" * update validation scripts to check for the correct header * add CONTRIBUTING.md file to explain how to make contributions and include a legal notice about licensing the contribution to Apple and the project * regenerate CONTRIBUTORS.md to reflect most recent contributions
1 parent cbe6a53 commit 018e139

22 files changed

+107
-25
lines changed

‎CONTRIBUTING.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
## Legal
2+
3+
By submitting a pull request, you represent that you have the right to license
4+
your contribution to Apple and the community, and agree by submitting the patch
5+
that your contributions are licensed under the Apache 2.0 license (see
6+
`LICENSE.txt`).
7+
8+
9+
## How to submit a bug report
10+
11+
Please ensure to specify the following:
12+
13+
* AsyncHTTPClient commit hash
14+
* Contextual information (e.g. what you were trying to achieve with AsyncHTTPClient)
15+
* Simplest possible steps to reproduce
16+
* More complex the steps are, lower the priority will be.
17+
* A pull request with failing test case is preferred, but it's just fine to paste the test case into the issue description.
18+
* Anything that might be relevant in your opinion, such as:
19+
* Swift version or the output of `swift --version`
20+
* OS version and the output of `uname -a`
21+
* Network configuration
22+
23+
24+
### Example
25+
26+
```
27+
AsyncHTTPClient commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757
28+
29+
Context:
30+
While load testing my program written with AsyncHTTPClient, I noticed
31+
that one file descriptor is leaked per request.
32+
33+
Steps to reproduce:
34+
1. ...
35+
2. ...
36+
3. ...
37+
4. ...
38+
39+
$ swift --version
40+
Swift version 4.0.2 (swift-4.0.2-RELEASE)
41+
Target: x86_64-unknown-linux-gnu
42+
43+
Operating system: Ubuntu Linux 16.04 64-bit
44+
45+
$ uname -a
46+
Linux beefy.machine 4.4.0-101-generic #124-Ubuntu SMP Fri Nov 10 18:29:59 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux
47+
48+
My system has IPv6 disabled.
49+
```
50+
51+
## Writing a Patch
52+
53+
A good AsyncHTTPClient patch is:
54+
55+
1. Concise, and contains as few changes as needed to achieve the end result.
56+
2. Tested, ensuring that any tests provided failed before the patch and pass after it.
57+
3. Documented, adding API documentation as needed to cover new functions and properties.
58+
4. Accompanied by a great commit message, using our commit message template.
59+
60+
### Commit Message Template
61+
62+
We require that your commit messages match our template. The easiest way to do that is to get git to help you by explicitly using the template. To do that, `cd` to the root of our repository and run:
63+
64+
git config commit.template dev/git.commit.template
65+
66+
### Make sure Tests work on Linux
67+
68+
AsyncHTTPClient uses XCTest to run tests on both macOS and Linux. While the macOS version of XCTest is able to use the Objective-C runtime to discover tests at execution time, the Linux version is not.
69+
For this reason, whenever you add new tests **you have to run a script** that generates the hooks needed to run those tests on Linux, or our CI will complain that the tests are not all present on Linux. To do this, merely execute `ruby ./scripts/generate_linux_tests.rb` at the root of the package and check the changes it made.
70+
71+
## How to contribute your work
72+
73+
Please open a pull request at https://github.com/swift-server/async-http-client. Make sure the CI passes, and then wait for code review.

‎CONTRIBUTORS.txt

+10-1
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,23 @@ needs to be listed here.
77

88
## COPYRIGHT HOLDERS
99

10-
- Swift Server Working Group
10+
- Apple Inc. (all contributors with '@apple.com')
1111

1212
### Contributors
1313

14+
- Andrew Lees <[email protected]>
1415
- Artem Redkin <[email protected]>
16+
- George Barnett <[email protected]>
1517
- Ian Partridge <[email protected]>
18+
- Joe Smith <[email protected]>
19+
- Johannes Weiss <[email protected]>
20+
- Ludovic Dewailly <[email protected]>
1621
- Tanner <[email protected]>
22+
- Tobias <[email protected]>
23+
- Trevör <[email protected]>
1724
- tomer doron <[email protected]>
25+
- tomer doron <[email protected]>
26+
- vkill <[email protected]>
1827

1928
**Updating this list**
2029

‎Package.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//
44
// This source file is part of the AsyncHTTPClient open source project
55
//
6-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
6+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
77
// Licensed under Apache License v2.0
88
//
99
// See LICENSE.txt for license information

‎Sources/AsyncHTTPClient/HTTPClient+HTTPCookie.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Sources/AsyncHTTPClient/HTTPClient.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Sources/AsyncHTTPClient/HTTPClientProxyHandler.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Sources/AsyncHTTPClient/HTTPHandler.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Sources/AsyncHTTPClient/RequestValidation.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Sources/AsyncHTTPClient/Utils.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Tests/AsyncHTTPClientTests/HTTPClientCookieTests+XCTest.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Tests/AsyncHTTPClientTests/HTTPClientCookieTests.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Tests/AsyncHTTPClientTests/HTTPClientInternalTests+XCTest.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Tests/AsyncHTTPClientTests/HTTPClientInternalTests.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Tests/AsyncHTTPClientTests/HTTPClientTestUtils.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Tests/AsyncHTTPClientTests/HTTPClientTests+XCTest.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Tests/AsyncHTTPClientTests/HTTPClientTests.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎Tests/LinuxMain.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// This source file is part of the AsyncHTTPClient open source project
44
//
5-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
5+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information

‎scripts/check_no_api_breakages.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
##
44
## This source file is part of the AsyncHTTPClient open source project
55
##
6-
## Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
6+
## Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
77
## Licensed under Apache License v2.0
88
##
99
## See LICENSE.txt for license information

‎scripts/generate_contributors_list.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
##
44
## This source file is part of the AsyncHTTPClient open source project
55
##
6-
## Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
6+
## Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
77
## Licensed under Apache License v2.0
88
##
99
## See LICENSE.txt for license information
@@ -27,7 +27,7 @@ cat > "$here/../CONTRIBUTORS.txt" <<- EOF
2727
2828
## COPYRIGHT HOLDERS
2929
30-
- Swift Server Working Group (all contributors with '@apple.com')
30+
- Apple Inc. (all contributors with '@apple.com')
3131
3232
### Contributors
3333

‎scripts/generate_docs.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
##
44
## This source file is part of the AsyncHTTPClient open source project
55
##
6-
## Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
6+
## Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
77
## Licensed under Apache License v2.0
88
##
99
## See LICENSE.txt for license information

‎scripts/generate_linux_tests.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def header(fileName)
3636
//
3737
// This source file is part of the AsyncHTTPClient open source project
3838
//
39-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
39+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
4040
// Licensed under Apache License v2.0
4141
//
4242
// See LICENSE.txt for license information

‎scripts/sanity.sh

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
##
44
## This source file is part of the AsyncHTTPClient open source project
55
##
6-
## Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
6+
## Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
77
## Licensed under Apache License v2.0
88
##
99
## See LICENSE.txt for license information
@@ -58,7 +58,7 @@ for language in swift-or-c bash dtrace; do
5858
//
5959
// This source file is part of the AsyncHTTPClient open source project
6060
//
61-
// Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
61+
// Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
6262
// Licensed under Apache License v2.0
6363
//
6464
// See LICENSE.txt for license information
@@ -77,7 +77,7 @@ EOF
7777
##
7878
## This source file is part of the AsyncHTTPClient open source project
7979
##
80-
## Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
80+
## Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
8181
## Licensed under Apache License v2.0
8282
##
8383
## See LICENSE.txt for license information
@@ -96,7 +96,7 @@ EOF
9696
*
9797
* This source file is part of the AsyncHTTPClient open source project
9898
*
99-
* Copyright (c) 2018-2019 Swift Server Working Group and the AsyncHTTPClient project authors
99+
* Copyright (c) 2018-2019 Apple Inc. and the AsyncHTTPClient project authors
100100
* Licensed under Apache License v2.0
101101
*
102102
* See LICENSE.txt for license information

0 commit comments

Comments
 (0)