Skip to content

Commit 8f6e69f

Browse files
maennchenmaennchen
committed
Add legalese
1 parent 3a6e81c commit 8f6e69f

File tree

4 files changed

+502
-0
lines changed

4 files changed

+502
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎.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

0 commit comments

Comments
 (0)