Skip to content

Commit f822439

Browse files
author
Ish Shah
committed
Init Commit
0 parents  commit f822439

File tree

6 files changed

+368
-0
lines changed

6 files changed

+368
-0
lines changed

Diff for: ‎CONTRIBUTING.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# How to contribute
2+
3+
Operator SDK is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into operator-sdk.
4+
5+
## Getting started
6+
7+
- Fork the repository on GitHub
8+
9+
## Reporting bugs and creating issues
10+
11+
Reporting bugs is one of the best ways to contribute.
12+
13+
## Contribution flow
14+
15+
This is a rough outline of what a contributor's workflow looks like:
16+
17+
- Create a topic branch from where to base the contribution. This is usually master.
18+
- Make commits of logical units.
19+
- Make sure commit messages are in the proper format (see below).
20+
- Push changes in a topic branch to a personal fork of the repository.
21+
- Submit a pull request to operator-framework/operator-sdk.
22+
- The PR must receive a LGTM from two maintainers found in the MAINTAINERS file.
23+
24+
Thanks for contributing!
25+
26+
### Code style
27+
28+
The coding style suggested by the Golang community is used in operator-sdk. See the [style doc][golang-style-doc] for details.
29+
30+
Please follow this style to make operator-sdk easy to review, maintain and develop.
31+
32+
### Format of the commit message
33+
34+
We follow a rough convention for commit messages that is designed to answer two
35+
questions: what changed and why. The subject line should feature the what and
36+
the body of the commit should describe the why.
37+
38+
```
39+
scripts: add the test-cluster command
40+
41+
this uses tmux to setup a test cluster that can easily be killed and started for debugging.
42+
43+
Fixes #38
44+
```
45+
46+
The format can be described more formally as follows:
47+
48+
```
49+
<subsystem>: <what changed>
50+
<BLANK LINE>
51+
<why this change was made>
52+
<BLANK LINE>
53+
<footer>
54+
```
55+
56+
The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
57+
58+
## Documentation
59+
60+
If the contribution changes the existing APIs or user interface it must include sufficient documentation to explain the use of the new or updated feature.

Diff for: ‎LICENSE

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

Diff for: ‎OWNERS

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# See the OWNERS docs: https://git.k8s.io/community/contributors/guide/owners.md
2+
3+
approvers:
4+
- java-sdk-admins
5+
- java-sdk-maintainers
6+
- java-sdk-approvers
7+
reviewers:
8+
- java-sdk-admins
9+
- java-sdk-reviewers
10+
- java-sdk-approvers

Diff for: ‎OWNERS_ALIASES

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# See the OWNERS docs: https://git.k8s.io/community/contributors/guide/owners.md
2+
3+
aliases:
4+
# active folks who can be contacted to perform admin-related
5+
# tasks on the repo, or otherwise approve any PRS.
6+
# java-sdk-admins:
7+
8+
# non-admin folks who have write-access and can approve any PRs in the repo
9+
# java-sdk-maintainers:
10+
11+
# non-admin folks who can approve any PRs in the repo
12+
# java-sdk-approvers:
13+
14+
# folks who can review and LGTM any PRs in the repo (doesn't
15+
# include approvers & admins -- those count too via the OWNERS
16+
# file)
17+
# java-sdk-reviewers:
18+
19+
# folks to can approve things in the directly-ported
20+
# testing_frameworks portions of the codebase
21+
# java-sdk-approvers:
22+
23+
24+
# folks who may have context on ancient history,
25+
# but are no longer directly involved
26+
# java-sdk-emeritus-maintainers:

Diff for: ‎SECURITY.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Operator SDK makes a constant stream of releases. In general, this means that security
6+
updates will be made in minor releases for the most recent major release only.
7+
8+
## Reporting a Vulnerability
9+
10+
To report a vulnerability, please follow the instructions at
11+
https://access.redhat.com/security/team/contact

Diff for: ‎code-of-conduct.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
## RedHat Community Code of Conduct
2+
3+
### Contributor Code of Conduct
4+
5+
As contributors and maintainers of this project, and in the interest of
6+
fostering an open and welcoming community, we pledge to respect all people who
7+
contribute through reporting issues, posting feature requests, updating
8+
documentation, submitting pull requests or patches, and other activities.
9+
10+
We are committed to making participation in this project a harassment-free
11+
experience for everyone, regardless of level of experience, gender, gender
12+
identity and expression, sexual orientation, disability, personal appearance,
13+
body size, race, ethnicity, age, religion, or nationality.
14+
15+
Examples of unacceptable behavior by participants include:
16+
17+
* The use of sexualized language or imagery
18+
* Personal attacks
19+
* Trolling or insulting/derogatory comments
20+
* Public or private harassment
21+
* Publishing others' private information, such as physical or electronic addresses, without explicit permission
22+
* Other unethical or unprofessional conduct.
23+
24+
Project maintainers have the right and responsibility to remove, edit, or
25+
reject comments, commits, code, wiki edits, issues, and other contributions
26+
that are not aligned to this Code of Conduct. By adopting this Code of Conduct,
27+
project maintainers commit themselves to fairly and consistently applying these
28+
principles to every aspect of managing this project. Project maintainers who do
29+
not follow or enforce the Code of Conduct may be permanently removed from the
30+
project team.
31+
32+
This code of conduct applies both within project spaces and in public spaces
33+
when an individual is representing the project or its community.
34+
35+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
36+
reported by contacting a project maintainer or the Operator SDK team <[email protected]>.
37+
38+
This Code of Conduct is adapted from the Contributor Covenant
39+
(http://contributor-covenant.org), version 1.2.0, available at
40+
http://contributor-covenant.org/version/1/2/0/
41+
42+
### RedHat Events Code of Conduct
43+
44+
RedHat events are working conferences intended for professional networking and
45+
collaboration in the RedHat community. Attendees are expected to behave
46+
according to professional standards and in accordance with their employer’s
47+
policies on appropriate workplace behavior.
48+
49+
While at RedHat events or related social networking opportunities, attendees
50+
should not engage in discriminatory or offensive speech or actions including
51+
but not limited to gender, sexuality, race, age, disability, or religion.
52+
Speakers should be especially aware of these concerns.
53+
54+
RedHat does not condone any statements by speakers contrary to these standards.
55+
RedHat reserves the right to deny entrance and/or eject from an event (without
56+
refund) any individual found to be engaging in discriminatory or offensive
57+
speech or actions.
58+
59+
Please bring any concerns to the immediate attention of designated on-site
60+
staff, or the Operator SDK team <[email protected]>.

0 commit comments

Comments
 (0)