Skip to content

Commit 679a004

Browse files
committed
Add legalese
1 parent 3a6e81c commit 679a004

File tree

4 files changed

+382
-0
lines changed

4 files changed

+382
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Code of Conduct
2+
3+
This project follows the [Elixir Code of Conduct](https://github.com/elixir-lang/elixir/blob/main/CODE_OF_CONDUCT.md).
4+
5+
We are committed to providing a friendly, safe, and welcoming environment for
6+
all contributors. By participating in this project, you agree to abide by the
7+
standards outlined in the Elixir Code of Conduct.
8+
9+
If you experience or witness behavior that violates the Code of Conduct, please
10+
report it to: [elixir-lang-conduct@googlegroups.com](mailto:elixir-lang-conduct@googlegroups.com).
11+
12+
Thank you for helping us foster a respectful and inclusive community!

.github/CONTRIBUTING.md

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# Contributing to `gettext`
2+
3+
## Welcome!
4+
5+
We look forward to your contributions! Here are some examples how you can
6+
contribute:
7+
8+
- [Report an issue](https://github.com/elixir-gettext/gettext/issues/new)
9+
- [Send a pull request](https://github.com/elixir-gettext/gettext/pulls)
10+
11+
## We have a Code of Conduct
12+
13+
Please note that this project is released with a
14+
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this
15+
project you agree to abide by its terms.
16+
17+
## Any contributions you make will be under the Apache 2.0 License
18+
19+
When you submit code changes, your submissions are understood to be under the
20+
same [Apache 2.0](https://github.com/elixir-gettext/gettext/blob/main/LICENSE)
21+
that covers the project. By contributing to this project, you agree that your
22+
contributions will be licensed under its Apache 2.0 License.
23+
24+
## Write bug reports with detail, background, and sample code
25+
26+
In your bug report, please provide the following:
27+
28+
- A quick summary and/or background
29+
- Steps to reproduce
30+
- Be specific!
31+
- Give sample code if you can.
32+
- What you expected would happen
33+
- What actually happens
34+
- Notes (possibly including why you think this might be happening, or stuff you
35+
- tried that didn't work)
36+
37+
<!-- TODO: Put in once v1 is released -->
38+
<!-- Please do not report a bug for a version of `gettext` that is no longer
39+
supported (`< 1.0.0`). Please do not report a bug if you are using a version of
40+
Erlang or Elixir that is not supported by the version of `gettext` you are using. -->
41+
42+
Please post code and output as text
43+
([using proper markup](https://guides.github.com/features/mastering-markdown/)).
44+
Do not post screenshots of code or output.
45+
46+
## Workflow for Pull Requests
47+
48+
1. Fork the repository.
49+
2. Create your branch from `main` if you plan to implement new functionality or
50+
change existing code significantly; create your branch from the oldest branch
51+
that is affected by the bug if you plan to fix a bug.
52+
3. Implement your change and add tests for it.
53+
4. Ensure the test suite passes.
54+
5. Ensure the code complies with our coding guidelines (see below).
55+
6. Send that pull request!
56+
57+
Please make sure you have
58+
[set up your user name and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup)
59+
for use with Git. Strings such as `silly nick name <root@localhost>` look really
60+
stupid in the commit history of a project.
61+
62+
We encourage you to
63+
[sign your Git commits with your GPG key](https://docs.github.com/en/github/authenticating-to-github/signing-commits).
64+
65+
Pull requests for new features must be based on the `main` branch.
66+
67+
We are trying to keep backwards compatibility breaks in `gettext` to a
68+
minimum. Please take this into account when proposing changes.
69+
70+
Due to time constraints, we are not always able to respond as quickly as we
71+
would like. Please do not take delays personal and feel free to remind us if you
72+
feel that we forgot to respond.
73+
74+
## Coding Guidelines
75+
76+
This project comes with configuration (located in `.formatter.exs` in the
77+
repository) that you can use to (re)format your
78+
source code for compliance with this project's coding guidelines:
79+
80+
```bash
81+
$ mix format
82+
```
83+
84+
Please understand that we will not accept a pull request when its changes
85+
violate this project's coding guidelines.
86+
87+
## Using `gettext` from a Git checkout
88+
89+
The following commands can be used to perform the initial checkout of
90+
`gettext`:
91+
92+
```bash
93+
$ git clone git@github.com:elixir-gettext/gettext.git
94+
95+
$ cd gettext
96+
```
97+
98+
Install `gettext`'s dependencies using [mix](https://hexdocs.pm/mix/Mix.html):
99+
100+
```bash
101+
$ mix deps.get
102+
```
103+
104+
## Running `gettext`'s test suite
105+
106+
After following the steps shown above, `gettext`'s test suite is run like
107+
this:
108+
109+
```bash
110+
$ mix test
111+
```
112+
113+
## Generating `gettext` Documentation
114+
115+
To generate the documentation for the library, run:
116+
117+
```bash
118+
$ mix docs
119+
```

.github/SECURITY.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Security Policy
2+
3+
[![OpenSSF Vulnerability Disclosure](https://img.shields.io/badge/OpenSSF-Vulnerability_Disclosure-green)][openssf-cvd-finders-guide]
4+
[![GitHub Report](https://img.shields.io/badge/GitHub-Security_Advisories-blue)][github-advisory-new]
5+
[![Email Report](https://img.shields.io/badge/Email-todo%40email.com-blue)][email]
6+
7+
We take the security of this software seriously and are committed to ensuring
8+
that any vulnerabilities are addressed promptly and effectively.
9+
10+
This repository follows the OpenSSF
11+
[Vulnerability Disclosure guide][openssf-cvd-guide].
12+
You can learn more about it in the [Finders Guide][openssf-cvd-finders-guide].
13+
14+
## Reporting Security Issues
15+
16+
If you believe you have found a security vulnerability in this repository,
17+
please report it via [GitHub Security Vulnerability Reporting][github-advisory-new]
18+
or via email to [`security@erlef.org`][email] if that is more suitable for you.
19+
20+
**Please do not report vulnerabilities through public channels** such as GitHub
21+
issues, discussions, or pull requests, to avoid exposing the details of the
22+
issue before it has been properly addressed.
23+
24+
We don't implement a bug bounty program or bounty rewards, but will work with
25+
you to ensure that your findings get the appropriate handling.
26+
27+
When reporting a vulnerability, please include as much detail as possible to
28+
help us triage and resolve the issue efficiently. Information that will be
29+
specially helpful includes:
30+
31+
- The type of issue (e.g., buffer overflow, SQL injection, cross-site scripting, etc.)
32+
- Full paths of source file(s) related to the issue
33+
- The location of the affected source code (e.g., tag, branch, commit, or direct URL)
34+
- Any special configuration required to reproduce the issue
35+
- Step-by-step instructions to reproduce the issue
36+
- Proof-of-concept or exploit code (if available)
37+
- The potential impact, including how the issue might be exploited by an attacker
38+
39+
Our vulnerability management team will respond within 3 working days of your
40+
report. If the issue is confirmed as a vulnerability, we will open a Security
41+
Advisory. This project follows a 90-day disclosure timeline.
42+
43+
If you have any questions about reporting security issues, please contact our
44+
vulnerability management team at [`todo@email.com`][email].
45+
46+
[openssf-cvd-guide]: https://github.com/ossf/oss-vulnerability-guide/tree/main
47+
[openssf-cvd-finders-guide]: https://github.com/ossf/oss-vulnerability-guide/blob/main/finder-guide.md
48+
[github-advisory-new]: /security/advisories/new
49+
[email]: mailto:todo@email.com

LICENSE

Lines changed: 202 additions & 0 deletions
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 2015 Plataformatec Copyright 2020 Dashbit
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.

0 commit comments

Comments
 (0)