Add CoC and Contributing

This commit is contained in:
Melody Becker 2024-09-16 21:34:46 +02:00
parent 704d0e8750
commit bb12231ff8
2 changed files with 79 additions and 0 deletions

27
CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,27 @@
# Linstrom Code of Conduct
The Linstrom project aims to be **enjoyable** for anyone to participate in, regardless of their identity or level of expertise. To achieve this, the community must create an environment which is **safe** and **equitable**; the following guidelines have been created with these goals in mind.
1. **This is not a professional space.** Individuality is not only welcome, but encouraged. Professionalism asks marginalized individuals to censor themselves, and perform their identity in an inauthentic, unchallenging manner, which caters solely to those in power (namely rich, white, cisgender, heterosexual men). Seeking professionalism is *antithetical* to the goal of equity, and thus, these guidelines reject it.
- Attempting to suppress self-expression or non-harmful speech is not acceptable for any reason.
- There will be queers, punks, femboys, drag queens, furries, hackers, kinksters, and all sorts of other people here. And the project will reflect that. If you don't like this, consider looking for Free Software projects [elsewhere](https://loose-files.keithhacks.cyou/img/trashcan.jpg).
2. **Treat individuals with respect.** Differing experiences and viewpoints deserve to be respected, and bigotry and harassment are not tolerated under any circumstances.
- Individuals should never be made to feel unsafe or unvalued due to their age, gender, sexuality, race, ethnicity, disability, religion, appearance, education, level of expertise, or other factors.
- Behaviour that is harmful in nature should be addressed and corrected *regardless of intent*.
- Respect personal boundaries and ask for clarification whenever they are unclear.
- (Obviously, hate does not count as merely a "differing viewpoint", because it is harmful in nature.)
3. **Be understanding of differences in communication.** Not everyone is aware of unspoken social cues, and speech that is not intended to be offensive should not be treated as such simply due to an atypical manner of communication.
- Somebody who speaks bluntly is not necessarily rude, and somebody who swears a lot is not necessarily volatile.
- Try to confirm your interpretation of their intent rather than assuming bad faith.
4. **"Uncomfortable" does not mean "unsafe".** In an ideal world, the community would be safe, equitable, enjoyable, *and* comfortable for all members at all times. Unfortunately, this is not always possible in reality.
- Safety and equity will be prioritized over comfort whenever it is necessary to do so.
- Weaponizing one's own discomfort to deflect accountability or censor an individual (e.g. "white fragility") is a form of discriminatory conduct.
5. **Let people grow from their mistakes.** Nobody is perfect; even the most well-meaning individual can do something hurtful. Everyone should be given a fair opportunity to explain themselves and correct their behaviour. Portraying someone as inherently malicious prevents improvement and shifts focus away from the *action* that was problematic.
- Avoid bringing up past events that do not accurately reflect an individual's current actions or beliefs. (This is, of course, different from providing evidence of a recurring pattern of behaviour.)
---
This document was created by ~keith as part of its default repository template, and is licensed under CC-BY-SA 4.0. The original template is here: <https://bytes.keithhacks.cyou/keith/default-template>

52
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,52 @@
# Contribution Guide
Thank you for your interest in contributing to Linstrom! All contributors are welcome, regardless of their level of experience.
## Bug Reports
Use the [bug report issue template](https://gitlab.com/mstarongitlab/linstrom/issues/new?template=bug-report.md) to file a bug report. Please include a detailed description of the events leading up to the problem, your system configuration, and the program logs. If you're able to reproduce the bug reliably, attaching a debugger to the program, triggering it, and uploading the results would be very helpful.
This section *should* tell you how to find your logs, attach the debugger, and do whatever else you need for a detailed bug report. But nobody filled it out. Attach a picture of Goatse to your bug reports until we fix this.
## Feature Requests
Use the [feature request issue template](https://gitlab.com/mstarongitlab/linstrom/issues/new?template=suggestion.md) to suggest new features. Please note that we haven't replaced this placeholder text with the actual criteria we're looking for, which means you should spam us with utterly nonsensical ideas.
## Submitting Translations
Translation files are part of the project codebase, so you'll have to fork the repository and file a pull request (see [Contributing Code](CONTRIBUTING.md#contributing-code) below). You don't need any programming knowledge to edit the translation files, though.
This should have been removed and replaced with a quick overview of where the files are and what translators need to do in order to edit them. Nobody did that, so think of this as a free pass to scream profanities into the issue tracker in your native language.
## Contributing Code
### Forking
If you'd like to have a go at writing some code for Linstrom, fork the repository, then create a new branch with a name that describes the changes you're making. If there's a [relevant issue](https://gitlab.com/mstarongitlab/linstrom/issues), include the issue number in the branch name:
```sh
git checkout -b 1337-prevent-computer-from-exploding
```
### Development Environment
We don't have a development environment, because nobody bothered to fill this out. Please add a new build system to the project specifically for your modifications. Bonus points if it's entirely nonsensical, like `npm` in a C project.
### Code Style
Use tabs instead of spaces, descriptive variable names, comments, blah blah blah. Actually, if you're still seeing this, *please* send us pull requests with the worst possible formatting you can come up with.
### Pull Requests
Once your modifications are complete, you'll want to fetch the latest changes from this repository, rebase your branch, and publish your changes:
```sh
git remote add upstream https://gitlab.com/mstarongitlab/linstrom.git
git checkout master
git pull upstream master
git checkout 1337-prevent-computer-from-exploding
git rebase master
git push --set-upstream origin 1337-prevent-computer-from-exploding
```
Finally, you can [create a pull request](https://gitlab.com/mstarongitlab/linstrom/pulls). It might not get approved, or you might have to make some additional changes to your code - but don't give up!