Skip to content

Commit a4c311e

Browse files
weissiweissi
committed
initial commit
0 parents  commit a4c311e

6 files changed

+424
-0
lines changed

‎CODE_OF_CONDUCT.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Code of Conduct
2+
To be a truly great community, SwiftNIO needs to welcome developers from all walks of life,
3+
with different backgrounds, and with a wide range of experience. A diverse and friendly
4+
community will have more great ideas, more unique perspectives, and produce more great
5+
code. We will work diligently to make the SwiftNIO community welcoming to everyone.
6+
7+
To give clarity of what is expected of our members, SwiftNIO has adopted the code of conduct
8+
defined by [contributor-covenant.org](https://www.contributor-covenant.org). This document is used across many open source
9+
communities, and we think it articulates our values well. The full text is copied below:
10+
11+
### Contributor Code of Conduct v1.3
12+
As contributors and maintainers of this project, and in the interest of fostering an open and
13+
welcoming community, we pledge to respect all people who contribute through reporting
14+
issues, posting feature requests, updating documentation, submitting pull requests or patches,
15+
and other activities.
16+
17+
We are committed to making participation in this project a harassment-free experience for
18+
everyone, regardless of level of experience, gender, gender identity and expression, sexual
19+
orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or
20+
nationality.
21+
22+
Examples of unacceptable behavior by participants include:
23+
- The use of sexualized language or imagery
24+
- Personal attacks
25+
- Trolling or insulting/derogatory comments
26+
- Public or private harassment
27+
- Publishing other’s private information, such as physical or electronic addresses, without explicit permission
28+
- Other unethical or unprofessional conduct
29+
30+
Project maintainers have the right and responsibility to remove, edit, or reject comments,
31+
commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of
32+
Conduct, or to ban temporarily or permanently any contributor for other behaviors that they
33+
deem inappropriate, threatening, offensive, or harmful.
34+
35+
By adopting this Code of Conduct, project maintainers commit themselves to fairly and
36+
consistently applying these principles to every aspect of managing this project. Project
37+
maintainers who do not follow or enforce the Code of Conduct may be permanently removed
38+
from the project team.
39+
40+
This code of conduct applies both within project spaces and in public spaces when an
41+
individual is representing the project or its community.
42+
43+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
44+
contacting a project maintainer at [[email protected]](mailto:[email protected]). All complaints will be reviewed and
45+
investigated and will result in a response that is deemed necessary and appropriate to the
46+
circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter
47+
of an incident.
48+
49+
*This policy is adapted from the Contributor Code of Conduct [version 1.3.0](https://contributor-covenant.org/version/1/3/0/).*
50+
51+
### Reporting
52+
A working group of community members is committed to promptly addressing any [reported issues](mailto:[email protected]).
53+
Working group members are volunteers appointed by the project lead, with a
54+
preference for individuals with varied backgrounds and perspectives. Membership is expected
55+
to change regularly, and may grow or shrink.

‎CONTRIBUTING.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
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+
* SwiftNIO commit hash
14+
* Contextual information (e.g. what you were trying to achieve with SwiftNIO)
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+
SwiftNIO commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757
28+
29+
Context:
30+
While load testing my HTTP web server written with SwiftNIO, 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 SwiftNIO 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+
### Test on Linux
67+
68+
SwiftNIO 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. For this reason, whenever you add new tests you will want 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 generate_linux_tests.rb` at the root of the package and check the changes it made.
69+
70+
## How to contribute your work
71+
72+
Please open a pull request at https://github.com/apple/swift-nio. Make sure the CI passes, and then wait for code review.

‎CONTRIBUTORS.txt

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
For the purpose of tracking copyright, this is the list of individuals and
2+
organizations who have contributed source code to SwiftNIO.
3+
4+
For employees of an organization/company where the copyright of work done
5+
by employees of that company is held by the company itself, only the company
6+
needs to be listed here.
7+
8+
## COPYRIGHT HOLDERS
9+
10+
- Apple Inc. (all contributors with '@apple.com')
11+
12+
### Contributors
13+
14+
- Cory Benfield <[email protected]>
15+
- Johannes Weiß <[email protected]>
16+
- Norman Maurer <[email protected]>
17+
- Tom Doron <[email protected]>

‎LICENSE.txt

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎NOTICE.txt

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
2+
The SwiftNIO Project
3+
====================
4+
5+
Please visit the SwiftNIO web site for more information:
6+
7+
* https://github.com/apple/swift-nio
8+
9+
Copyright 2017, 2018 The SwiftNIO Project
10+
11+
The SwiftNIO Project licenses this file to you under the Apache License,
12+
version 2.0 (the "License"); you may not use this file except in compliance
13+
with the License. You may obtain a copy of the License at:
14+
15+
https://www.apache.org/licenses/LICENSE-2.0
16+
17+
Unless required by applicable law or agreed to in writing, software
18+
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
19+
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
20+
License for the specific language governing permissions and limitations
21+
under the License.
22+
23+
Also, please refer to each LICENSE.<component>.txt file, which is located in
24+
the 'license' directory of the distribution file, for the license terms of the
25+
components that this product depends on.
26+
27+
-------------------------------------------------------------------------------
28+
29+
This product is heavily influenced by Netty.
30+
31+
* LICENSE (Apache License 2.0):
32+
* https://github.com/netty/netty/blob/4.1/LICENSE.txt
33+
* HOMEPAGE:
34+
* https://netty.io
35+
36+
---
37+
38+
This product contains a derivation of the Tony Stone's 'process_test_files.rb'.
39+
40+
* LICENSE (Apache License 2.0):
41+
* https://www.apache.org/licenses/LICENSE-2.0
42+
* HOMEPAGE:
43+
* https://codegists.com/snippet/ruby/generate_xctest_linux_runnerrb_tonystone_ruby

0 commit comments

Comments
 (0)