ilyagr.bsky.social
just playing with tangled
Boilerplate for new Google open source project
+398
+16
.github/ISSUE_TEMPLATE.md
+16
.github/ISSUE_TEMPLATE.md
+6
.github/PULL_REQUEST_TEMPLATE.md
+6
.github/PULL_REQUEST_TEMPLATE.md
+202
LICENSE
+202
LICENSE
···
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.
+53
README.md
+53
README.md
···
1
+
# New Project Template
2
+
3
+
This repository contains a template that can be used to seed a repository for a
4
+
new Google open source project.
5
+
6
+
See [go/releasing](http://go/releasing) (available externally at
7
+
https://opensource.google/docs/releasing/) for more information about
8
+
releasing a new Google open source project.
9
+
10
+
This template uses the Apache license, as is Google's default. See the
11
+
documentation for instructions on using alternate license.
12
+
13
+
## How to use this template
14
+
15
+
1. Clone it from GitHub.
16
+
* There is no reason to fork it.
17
+
1. Create a new local repository and copy the files from this repo into it.
18
+
1. Modify README.md and docs/contributing.md to represent your project, not the
19
+
template project.
20
+
1. Develop your new project!
21
+
22
+
``` shell
23
+
git clone https://github.com/google/new-project
24
+
mkdir my-new-thing
25
+
cd my-new-thing
26
+
git init
27
+
cp -r ../new-project/* ../new-project/.github .
28
+
git add *
29
+
git commit -a -m 'Boilerplate for new Google open source project'
30
+
```
31
+
32
+
## Source Code Headers
33
+
34
+
Every file containing source code must include copyright and license
35
+
information. This includes any JS/CSS files that you might be serving out to
36
+
browsers. (This is to help well-intentioned people avoid accidental copying that
37
+
doesn't comply with the license.)
38
+
39
+
Apache header:
40
+
41
+
Copyright 2020 Google LLC
42
+
43
+
Licensed under the Apache License, Version 2.0 (the "License");
44
+
you may not use this file except in compliance with the License.
45
+
You may obtain a copy of the License at
46
+
47
+
https://www.apache.org/licenses/LICENSE-2.0
48
+
49
+
Unless required by applicable law or agreed to in writing, software
50
+
distributed under the License is distributed on an "AS IS" BASIS,
51
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
52
+
See the License for the specific language governing permissions and
53
+
limitations under the License.
+93
docs/code-of-conduct.md
+93
docs/code-of-conduct.md
···
1
+
# Code of Conduct
2
+
3
+
## Our Pledge
4
+
5
+
In the interest of fostering an open and welcoming environment, we as
6
+
contributors and maintainers pledge to making participation in our project and
7
+
our community a harassment-free experience for everyone, regardless of age, body
8
+
size, disability, ethnicity, gender identity and expression, level of
9
+
experience, education, socio-economic status, nationality, personal appearance,
10
+
race, religion, or sexual identity and orientation.
11
+
12
+
## Our Standards
13
+
14
+
Examples of behavior that contributes to creating a positive environment
15
+
include:
16
+
17
+
* Using welcoming and inclusive language
18
+
* Being respectful of differing viewpoints and experiences
19
+
* Gracefully accepting constructive criticism
20
+
* Focusing on what is best for the community
21
+
* Showing empathy towards other community members
22
+
23
+
Examples of unacceptable behavior by participants include:
24
+
25
+
* The use of sexualized language or imagery and unwelcome sexual attention or
26
+
advances
27
+
* Trolling, insulting/derogatory comments, and personal or political attacks
28
+
* Public or private harassment
29
+
* Publishing others' private information, such as a physical or electronic
30
+
address, without explicit permission
31
+
* Other conduct which could reasonably be considered inappropriate in a
32
+
professional setting
33
+
34
+
## Our Responsibilities
35
+
36
+
Project maintainers are responsible for clarifying the standards of acceptable
37
+
behavior and are expected to take appropriate and fair corrective action in
38
+
response to any instances of unacceptable behavior.
39
+
40
+
Project maintainers have the right and responsibility to remove, edit, or reject
41
+
comments, commits, code, wiki edits, issues, and other contributions that are
42
+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
43
+
contributor for other behaviors that they deem inappropriate, threatening,
44
+
offensive, or harmful.
45
+
46
+
## Scope
47
+
48
+
This Code of Conduct applies both within project spaces and in public spaces
49
+
when an individual is representing the project or its community. Examples of
50
+
representing a project or community include using an official project e-mail
51
+
address, posting via an official social media account, or acting as an appointed
52
+
representative at an online or offline event. Representation of a project may be
53
+
further defined and clarified by project maintainers.
54
+
55
+
This Code of Conduct also applies outside the project spaces when the Project
56
+
Steward has a reasonable belief that an individual's behavior may have a
57
+
negative impact on the project or its community.
58
+
59
+
## Conflict Resolution
60
+
61
+
We do not believe that all conflict is bad; healthy debate and disagreement
62
+
often yield positive results. However, it is never okay to be disrespectful or
63
+
to engage in behavior that violates the project’s code of conduct.
64
+
65
+
If you see someone violating the code of conduct, you are encouraged to address
66
+
the behavior directly with those involved. Many issues can be resolved quickly
67
+
and easily, and this gives people more control over the outcome of their
68
+
dispute. If you are unable to resolve the matter for any reason, or if the
69
+
behavior is threatening or harassing, report it. We are dedicated to providing
70
+
an environment where participants feel welcome and safe.
71
+
72
+
Reports should be directed to *[PROJECT STEWARD NAME(s) AND EMAIL(s)]*, the
73
+
Project Steward(s) for *[PROJECT NAME]*. It is the Project Steward’s duty to
74
+
receive and address reported violations of the code of conduct. They will then
75
+
work with a committee consisting of representatives from the Open Source
76
+
Programs Office and the Google Open Source Strategy team. If for any reason you
77
+
are uncomfortable reaching out to the Project Steward, please email
78
+
opensource@google.com.
79
+
80
+
We will investigate every complaint, but you may not receive a direct response.
81
+
We will use our discretion in determining when and how to follow up on reported
82
+
incidents, which may range from not taking action to permanent expulsion from
83
+
the project and project-sponsored spaces. We will notify the accused of the
84
+
report and provide them an opportunity to discuss it before any action is taken.
85
+
The identity of the reporter will be omitted from the details of the report
86
+
supplied to the accused. In potentially harmful situations, such as ongoing
87
+
harassment or threats to anyone's safety, we may take action without notice.
88
+
89
+
## Attribution
90
+
91
+
This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
92
+
available at
93
+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+28
docs/contributing.md
+28
docs/contributing.md
···
1
+
# How to Contribute
2
+
3
+
We'd love to accept your patches and contributions to this project. There are
4
+
just a few small guidelines you need to follow.
5
+
6
+
## Contributor License Agreement
7
+
8
+
Contributions to this project must be accompanied by a Contributor License
9
+
Agreement. You (or your employer) retain the copyright to your contribution;
10
+
this simply gives us permission to use and redistribute your contributions as
11
+
part of the project. Head over to <https://cla.developers.google.com/> to see
12
+
your current agreements on file or to sign a new one.
13
+
14
+
You generally only need to submit a CLA once, so if you've already submitted one
15
+
(even if it was for a different project), you probably don't need to do it
16
+
again.
17
+
18
+
## Code reviews
19
+
20
+
All submissions, including submissions by project members, require review. We
21
+
use GitHub pull requests for this purpose. Consult
22
+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23
+
information on using pull requests.
24
+
25
+
## Community Guidelines
26
+
27
+
This project follows [Google's Open Source Community
28
+
Guidelines](https://opensource.google/conduct/).