Skip to content

Commit a766afa

Browse files
jrollijrolli
committed
Initial commit
1 parent 2fe2ce8 commit a766afa

File tree

11 files changed

+993
-2
lines changed

11 files changed

+993
-2
lines changed

‎CONTRIBUTING.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Contributors Guide
2+
3+
cmgr is an open source project. If you are interested in making it better,
4+
there are many ways you can contribute. For example, you can:
5+
6+
- Submit a bug report
7+
8+
- Suggest a new feature
9+
10+
- Provide feedback by commenting on feature requests/proposals
11+
12+
- Propose a patch by submitting a pull request
13+
14+
- Suggest or submit documentation improvements
15+
16+
- Review outstanding pull requests
17+
18+
- Answer questions from other users
19+
20+
- Share the software with other users who are interested
21+
22+
- Teach others to use the software
23+
24+
- Package and distribute the software in a downstream community (such as your
25+
preferred Linux distribution)
26+
27+
## Bugs and Feature Requests
28+
29+
If you believe that you have found a bug or wish to propose a new feature,
30+
please first search the existing [issues] to see if it has already been
31+
reported. If you are unable to find an existing issue, consider using one of
32+
the provided templates to create a new issue and provide as many details as
33+
you can to assist in reproducing the bug or explaining your proposed feature.
34+
35+
## Patch Submission tips
36+
37+
Patches should be submitted in the form of Pull Requests to the [repository]
38+
on GitHub. But first, consider the following tips to ensure a smooth process
39+
when submitting a patch:
40+
41+
- Ensure that the patch compiles and does not break any build-time tests.
42+
43+
- Be understanding, patient, and friendly; developers may need time to review
44+
your submissions before they can take action or respond. This does not mean
45+
your contribution is not valued. If your contribution has not received a
46+
response in a reasonable time, consider commenting with a polite inquiry for
47+
an update.
48+
49+
- Limit your patches to the smallest reasonable change to achieve your
50+
intended goal. For example, do not make unnecessary indentation changes; but
51+
don't go out of your way to make the patch so minimal that it isn't easy to
52+
read, either. Consider the reviewer's perspective.
53+
54+
- Isolate multiple patches from each other. If you wish to make several
55+
independent patches, do so in separate, smaller pull requests that can be
56+
reviewed more easily.
57+
58+
- Be prepared to answer questions from reviewers. They may have further
59+
questions before accepting your patch, and may even propose changes. Please
60+
accept this feedback constructively, and not as a rejection of your proposed
61+
change.
62+
63+
## Review
64+
65+
- We welcome code reviews from anyone. A committer is required to formally
66+
accept and merge the changes.
67+
68+
- Reviewers will be looking for things like correctness, API design,
69+
duplication of existing functionality, readability and code style, avoidance
70+
of bloat (scope-creep), etc.
71+
72+
- Reviewers will likely ask questions to better understand your change.
73+
74+
- Reviewers will make comments about changes to your patch:
75+
76+
- MUST means that the change is required
77+
78+
- SHOULD means that the change is suggested, further discussion on the
79+
subject may be required
80+
81+
- COULD means that the change is optional
82+
83+
## Legal
84+
85+
Consistent with Section D.6. of the GitHub Terms of Service as of 2019, and
86+
Section 5. of the Apache License, Version 2.0, the project maintainer for this
87+
project accepts contributions using the inbound=outbound model. When you
88+
submit a pull request to this repository (inbound), you are agreeing to
89+
license your contribution under the same terms as specified in [LICENSE]
90+
(outbound).
91+
92+
This is an open source project. Contributions you make to this public U.S.
93+
Government ("USG") repository are completely voluntary. When you submit an
94+
issue, bug report, question, enhancement, pull request, etc., you are offering
95+
your contribution without expectation of payment, you expressly waive any
96+
future pay claims against the USG related to your contribution, and you
97+
acknowledge that this does not create an obligation on the part of the USG of
98+
any kind. Furthermore, your contributing to this project does not create an
99+
employer-employee relationship between the United States ("U.S.") Government
100+
and the contributor.
101+
102+
[issues]: https://github.com/ArmyCyberInstitute/cmgr/issues
103+
104+
[repository]: https://github.com/ArmyCyberInstitute/cmgr/
105+
106+
[LICENSE]: LICENSE

‎DISCLAIMER.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Disclaimer of Warranty
2+
3+
This Work is provided "AS IS." Any express or implied warranties, including
4+
but not limited to, the implied warranties of merchantability and fitness for
5+
a particular purpose are disclaimed. In no event shall the United States
6+
Government be liable for any direct, indirect, incidental, special, exemplary
7+
or consequential damages (including, but not limited to, procurement of
8+
substitute goods or services, loss of use, data or profits, or business
9+
interruption) however caused and on any theory of liability, whether in
10+
contract, strict liability, or tort (including negligence or otherwise)
11+
arising in any way out of the use of this Work, even if advised of the
12+
possibility of such damage.
13+
14+
The User of this Work agrees to hold harmless and indemnify the United States
15+
Government, its agents and employees from every claim or liability (whether in
16+
tort or in contract), including attorney's fees, court costs, and expenses,
17+
arising in direct consequence of Recipient's use of the item, including, but
18+
not limited to, claims or liabilities made for injury to or death of personnel
19+
of User or third parties, damage to or destruction of property of User or
20+
third parties, and infringement or other violations of intellectual property
21+
or technical data rights.
22+
23+
# Disclaimer of Endorsement
24+
25+
Nothing in this Work is intended to constitute an endorsement, explicit or
26+
implied, by the United States Government of any particular manufacturer's
27+
product or service.
28+
29+
Reference herein to any specific commercial product, process, or service by
30+
trade name, trademark, manufacturer, or otherwise, in this Work does not
31+
constitute an endorsement, recommendation, or favoring by the United States
32+
Government and shall not be used for advertising or product endorsement
33+
purposes.

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
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.

‎NOTICE‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
cmgr
2+
3+
This product includes software developed by the Army Cyber Institute at West Point
4+
(https://cyber.army.mil).
5+
6+
Portions of this product were created by the U.S. Government and not subject to
7+
U.S. copyright protections under 17 U.S.C.
8+
9+
The remaining portions are copyright their respective authors and have been
10+
contributed under the terms of one or more open source licenses, and made
11+
available to you under the terms of those licenses. (See LICENSE)
12+
13+
14+
15+
Licensing Intent
16+
17+
The intent is that this software and documentation ("Project") should be treated
18+
as if it is licensed under the license associated with the Project ("License")
19+
in the LICENSE file. However, because we are part of the United States (U.S.)
20+
Federal Government, it is not that simple.
21+
22+
The portions of this Project written by U.S. Federal Government employees within
23+
the scope of their federal employment are ineligible for copyright protection in
24+
the U.S.; this is generally understood to mean that these portions of the
25+
Project are placed in the public domain.
26+
27+
In countries where copyright protection is available (which does not include the
28+
U.S.), contributions made by U.S. Federal Government employees are released
29+
under the License. Merged contributions from private contributors are released
30+
under the License.
31+
32+
The cmgr software is released under the Apache License, Version 2.0 ("Apache 2.0").
33+
34+
Consistent with the inbound=outbound model, contributions to any module must be
35+
made available, by the contributor, under the applicable license(s). Please read
36+
the Legal section of the CONTRIBUTING.md guide.

0 commit comments

Comments
 (0)