Skip to content

Commit 4cfc89d

Browse files
committed
docs(standards) security, coc, and contrib
1 parent bb42663 commit 4cfc89d

File tree

3 files changed

+130
-0
lines changed

3 files changed

+130
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributor Code of Conduct
2+
3+
## Our Pledge
4+
5+
As maintainers and contributors, we pledge to make participation in our project a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy project.
6+
7+
## Our Standards
8+
9+
**Examples of behavior that contributes to a positive environment for our project include:**
10+
11+
- Demonstrating empathy and kindness toward other people
12+
- Being respectful of differing opinions, viewpoints, and experiences
13+
- Giving and gracefully accepting constructive feedback
14+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
15+
- Focusing on what is best not just for us as individuals, but for the overall project
16+
17+
**Examples of unacceptable behavior include:**
18+
19+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
20+
- Trolling, insulting or derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Doxxing or Publishing others' personal / private information
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
When we disagree, stop and try to understand the other person's perspective.
26+
27+
Disagreements, both social and technical, happen all the time and open source projects are no exception. It is important that we resolve disagreements and differing views constructively. _Remember that we're different!_
28+
29+
## Enforcement Guidelines
30+
31+
### 1. Warning
32+
33+
**Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome to the project.
34+
35+
**Consequence**: A written warning providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
36+
37+
### 3. Temporary Ban
38+
39+
**Impact**: A serious violation of project standards, including sustained inappropriate behavior.
40+
41+
**Consequence**: A temporary ban from any sort of interaction or public communication with the project for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
42+
43+
### 4. Permanent Ban
44+
45+
**Impact**: Demonstrating a pattern of violation of project standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
46+
47+
**Consequence**: A permanent ban from any sort of public interaction with the project.
48+
49+
## Reporting
50+
51+
You can publicly mention [@xero](https://github.com/xero) or privately via [PGP signed email](https://0w.nz/pgp.pub) or [Matrix](https://matrix.to/#/@x0:rx.haunted.computer)
52+
53+
## Attribution
54+
55+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org) and the [Speak Up! Community Code of Conduct](http://web.archive.org/web/20141109123859/http://speakup.io/coc.html)
56+

.github/CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing
2+
3+
I'm really glad you're reading this, people make projects better.
4+
5+
## Did you find a bug?
6+
7+
- Ensure the bug was not already reported by searching our [GitHub Issues](https://github.com/xero/text0wnz/issues).
8+
- If you're unable to find an open issue addressing the problem, open a new one.
9+
- Be sure to include a title and clear description, as much relevant information as possible.
10+
- A code sample or an execution test case demonstrating the expected behavior that is not occurring.
11+
12+
> ### **Do not open up a issue if the bug is a security vulnerability**
13+
> Instead to refer to our [security policy](https://github.com/xero/text0wnz/blob/main/.github/SECURITY.md) and submit a private [advisory](https://github.com/xero/text0wnz/security/advisories/new).
14+
15+
## Did you fix a bug?
16+
17+
- Open a new GitHub pull request with the patch.
18+
- Ensure the PR description clearly describes the problem and solution.
19+
- Include the relevant issue number if applicable.
20+
21+
## Did you write a new feature?
22+
23+
- Rad! Please [lint, format](https://github.com/xero/text0wnz/wiki/building-and-developing#code-quality-scripts), and [test](https://github.com/xero/text0wnz/wiki/testing) your code before submitting a [pull request](https://github.com/xero/text0wnz/pulls).
24+
25+
# Do you have question about the code or using the app?
26+
27+
- First, please review our detailed [wiki](https://github.com/xero/text0wnz/wiki)
28+
- If you still need help, feel free to open a new [issue](https://github.com/xero/text0wnz/issues).
29+
- Be as detailed as possible, including screenshots if necessary.

.github/SECURITY.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Security Policy
2+
3+
The makers of the `teXt0wnz` application value your security and privacy. We are committed to maintaining a secure application and full transparency about how your data is handled.
4+
5+
## Supported Versions
6+
7+
The following versions of `text0w.nz` are currently being supported with security updates:
8+
9+
| Version | Supported |
10+
| ------- | ------------------ |
11+
| 2.x.x | :white_check_mark: |
12+
| 1.0.x | :x: |
13+
14+
## Reporting a Vulnerability
15+
16+
If you discover a flaw in the application (client or server) please submit a new [security advisory](https://github.com/xero/text0wnz/security/advisories/new).
17+
18+
If you do not wish to use GitHub, you can contact the project maintainer directly via [PGP signed email](https://0w.nz/pgp.pub) or [Matrix](https://matrix.to/#/@x0:rx.haunted.computer)
19+
20+
Make sure your advisory includes the following information:
21+
- Detailed explanation of the issue
22+
- text0wnz software version and commit hash used
23+
- POC exploiting the vulnerability
24+
- Any logs that might be available
25+
- Contact info if you wish to talk outside of github
26+
- If possible, suggested fixes, mitigations, or solutions to the issue
27+
28+
Your advisory will be triaged by our team ASAP. We will undoubtedly contact you for more information.
29+
30+
> **Please Note:** this is an open-source project and we do not award monetary bug bounties. As a thank you, your name will be added to contributors list crediting your work.
31+
32+
## Privacy
33+
34+
_You_ have full control over your data. No personal data is collected or stored unless you voluntarily include it in your artwork’s "[sauce](https://github.com/xero/text0wnz/wiki/sauce-format)" metadata. All data remains on your device and is never unknowingly transferred; only files you explicitly choose to save or export leave your device.
35+
36+
### Cookies and Tracking
37+
We **do not** use cookies, tracking technologies, or similar mechanisms.
38+
39+
### Data Storage and Usage
40+
41+
**Local Storage**: This application uses your device’s local storage to save the following information about your artwork:
42+
- CANVAS_DATA: The raw drawing data for your current artwork.
43+
- FONT_NAME, PALETTE_COLORS, ICE_COLORS, LETTER_SPACING, XBIN_FONT_DATA: Editor font and configuration settings to ensure a consistent experience.
44+
45+
For more information, see our [Privacy Policy](https://github.com/xero/text0wnz/wiki/privacy)

0 commit comments

Comments
 (0)