nhcarrigan/docs
2
0
Fork 0
generated from nhcarrigan/template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: migrate from github

Browse Source
This commit is contained in:
Naomi Carrigan
2024-05-12 01:45:37 -07:00
commit 027cee7ae2
58 changed files with 3548 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/community/appeal.md Normal file
View File

@ -0,0 +1,19 @@
# Appealing A Moderator Decision
Our moderators do not take punitive action (such as kicks, bans, etc.) lightly. However, misunderstandings do happen and everyone makes mistakes.
If you feel that you were restricted from our community unfairly, you can reach out to Naomi to discuss the decision.
## Preparing for Your Appeal
Before reaching out to us, be prepared with some information.
- Have you read our rules and code of conduct?
- Do you agree to follow them?
- Why do you think a moderator took action against you?
- Why do you think this action was unfair?
- Why do you want to resume interaction with our community? What value do you feel you would add?
If you are not prepared for your appeal, we will be less likely to approve it.
[Appeal A Ban](https://airtable.com/appV1cYj57zUU1Af2/pagEeCCMdz5T6cHi9/form)

85
docs/community/guide.md Normal file
View File

@ -0,0 +1,85 @@
# Community Guidelines
> [!DANGER]
> Due to the heavy nature of topics discussed in our community, and to ensure the comfort of all of our members, participants must be 18 years or older to interact with us.
> Exceptions are made for the professional platforms listed on [our contact page](/contact)
This page documents some helpful tips that will maximise the value you get from (and bring to) our community. The guidelines here are not strict rules or requirements, but are highly encouraged to keep our community safe and cosy for everyone.
## Do not Argue with Staff
Our staff team consists of members who have been trusted with tools to help keep the community safe. But they are still human! We all make mistakes.
If you feel a staff decision was made in error or bad faith, do not argue directly with the team. Instead, fill out our [appeal form](/community/appeal) and we will review your case. Only Naomi has access to this form, and submissions will only be shared in the minimum capacity necessary to investigate and resolve the issue. Your name will not be associated with any revealed submission information.
## Plural Systems
Plural systems are more than welcome in our community. Please do not pressure someone to reveal information about one of their alters, or attempt to discover who used Melody's plural proxying.
Systems are welcome to disclose whatever information they want about their alters.
## Tone Tags
One of the biggest disadvantages of text-based communication is the loss of context that provides the tone of the message. To help with this, we use tone tags as needed when the tone of a message might be misinterpreted.
We encourage you to use these tags as needed.
| Tag | Meaning |
| ---------------------- | ------------------------------------ |
| `/aff` | Affectionate |
| `/apa` | Apathetic |
| `/b` | Bitter |
| `/cel` | Celebratory |
| `/ci` | Caring Intent |
| `/cj` | Coping Joke |
| `/co` or `/cf` | Comforting |
| `/ex` | Exaggeration |
| `/f` | fake |
| `/fam` | Familial |
| `/fex` | for example |
| `/gen` or `/g` | Genuine |
| `/genq` or `/gq` | Genuine Question |
| `/gens` or `/gs` | Genuine Suggestion |
| `/hj` | Half Joking |
| `/hyp` | Hyperbole |
| `/ij` | Inside Joke |
| `/info` | Information |
| `/j` | Joking |
| `/jov` | Jokingly Overreacting |
| `/l`, `/ly` or `/lyr` | Lyrics |
| `/lh` | Lighthearted |
| `/li` or `/lit` | Literally |
| `/lu` | Little Upset |
| `/m` | Metaphorically |
| `/md` | Melodramatic |
| `/nav` | Not A Vent |
| `/nay` | Not At You |
| `/nbh` | Nobody Here (for vague venting only) |
| `/nbr` | Not Being Rude |
| `/nc` or `/neg` | Negative connotation |
| `/ncm` | Not Comparing |
| `/neu` | Neutral connotation |
| `/nf` | Not Forced |
| `/nm` | Not Mad (or upset) |
| `/np` | No Pressure |
| `/npa` | Not Passive Aggressive |
| `/nsx` or `/nx` | Non Sexual Intent |
| `/ny` | Not Yelling |
| `/op` | Optional |
| `/ot` | Off Topic |
| `/p` or `/plat` | Platonic |
| `/pc` or `/pos` | Positive connotation |
| `/q` | Quote |
| `/ref` | Reference |
| `/rh`, `/rt` or `/rhq` | Rhetorical Question |
| `/s` or `/sar` | Sarcastic |
| `/srs` | Serious |
| `/sym` | Sympathetic |
| `/t` | Teasing |
| `/tc`, `/ti` or `/tic` | Typing a tic |
## Pronouns
You are encouraged to display your pronouns in your platform bio (or use the roles in our Discord community). Doing this not only helps others know how to refer to you, but also helps normalise the practice of sharing pronouns.
By normalising that practice, we fight against the assumption that only trans folk share their pronouns, which makes our community safer for trans folk to do so without implicitly outing themselves.

92
docs/community/labels.md Normal file
View File

@ -0,0 +1,92 @@
# Labels
We use very specific labels to help categorise our issues. This page explains what each label means.
## Contribution Labels
These are the most important. These labels indicate who is encouraged to make a pull request to resolve the issue.
| Label | Explanation |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `good first issue` | An issue with this label is intended for contributors who are brand new to the project. These issues should not require prior knowledge of the codebase, and the conversation on the issue will include a detailed description of how to implement a resolution. |
| `help wanted` | These issues are open for contribution from anyone who is interested. The conversation may not include a detailed description, as these issues typically assume you have prior experience with the codebase. |
| `🔒 staff only` | These issues require specific access to the production infrastructure to test properly. These are restricted to project maintainers/staff for that reason. |
## Aspect Labels
These labels indicate the scope of the work required to resolve the issue.
| Label | Explanation |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `💻 aspect: code` | This is the most common. These issues require work on the project's code-base. |
| `🤖 aspect: dx` | These issues typically require changes to the project's tooling, such as automated tests, development dependencies, etc. |
| `🕹 aspect: interface` | These issues might require code changes, but these are specifically things that require changing the end-user's experience. This might be something like CSS changes, or replacing an image. |
| `📄 aspect: text` | These issues are related to a project's documentation. These don't require code changes, but might require markdown experience as most of our documentation is written in markdown. |
## Goal Labels
These labels indicate the goal of the issue. Our projects tend to follow a specific modular approach, and these labels help indicate the type of changes you might be making.
| Label | Explanation |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `⭐ goal: addition` | These issues add a new feature to the project. Typically, this means you're adding a new code file from scratch, following the project's style. |
| `🛠 goal: fix` | These issues fix a bug in the project. Typically, this means you're editing existing code within existing files. |
| `✨ goal: improvement` | These issues expand upon an existing feature. Typically, this means you're adding code to an existing file, but not necessarily adding new files. |
## Priority Labels
The priority labels indicate the importance we've assigned to a specific issue. The higher the priority, the more of a focus it is for our team.
| Label | Explanation |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `🟥 priority: critical` | These issues are typically show-stoppers. This label is reserved for issues which need immediate attention because the project is **unusable** until they are resolved. |
| `🟧 priority: high` | This label applies to issues that aren't preventing the project from being _functional_, but are preventing further development until they're resolved. |
| `🟨 priority: medium` | Medium priority issues are things that we want resolved as soon as possible, but they aren't preventing other development from occurring. |
| `🟩 priority: low` | This is probably the most common label. This is for issues that we'd like resolved, but aren't considered as things we want done ASAP. |
| `🟪 priority: none` | This label indicates an issue that would be nice to have resolved, but isn't essential enough to dedicate maintainer time to fixing. |
## Status Labels
Status labels allow you to see where a ticket is at in the lifecycle of the project.
| Label | Explanation |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `🚦 status: awaiting triage` | This is the most common status label. This label is automatically applied to new issues, and indicates that the maintainer team has not reviewed and responded to the issue. You are still welcome to share your thoughts, but these issues have not received any maintainer attention. |
| `🚧 status: blocked` | This label is applied to issues that might have a planned resolution, but that resolution depends on a separate issue being resolved. These aren't ready for work **yet**, but will be soon. |
| `⛔️ status: discarded` | This label applies to an issue that we don't intend to resolve. Typically, this is on feature requests that aren't in line with the project's goals. |
| `🙅 status: discontinued` | We rarely use this label, but this applies to feature request issues on projects that are solely in maintenance mode - that is, projects we aren't adding new features to but are still supporting and providing bug fixes for. |
| `🏷 status: label work required` | This applies to an issue that might have some discussion on it, but hasn't been appropriately labelled and categorised. |
| `🏁 status: ready for dev` | These issues are ready for contribution. If a contributor is assigned, they have indicated interest in working on the issue and we encourage you to collaborate. This pairs with the Contribution Labels listed above. |
| `🧹 status: ticket work required` | This label indicates that the issue does not have enough information for proper triage. Typically, this pairs with the Conversation Labels listed below. |
## Conversation Labels
These labels indicate that the issue has received initial maintainer attention, but is waiting on more information from the author or the maintainer team.
| Label | Explanation |
| --------------------- | ---------------------------------------------------------------------------------------------------- |
| `💬 talk: discussion` | This issue is being actively discussed, but has not been accepted as something we intend to resolve. |
| `❓ talk: question` | These issues are waiting on additional information from the author in order to triage properly. |
## Special Labels
These labels are specifically used for unique events.
| Label | Explanation |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Hacktoberfest` | This issue is indicated as a valid contribution opportunity for Hacktoberfest. |
| `hacktoberfest-accepted` | This is used to label pull requests which are valid Hacktoberfest contributions, but might not be merged in time for the event. |
| `invalid` | This label is specifically used on pull requests which were made with the goal of spamming Hacktoberfest contributions, and were not made in good faith. |
## Pull Request Labels
We have automation that applies specific labels to our pull requests.
| Label | Explanation |
| --------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `✅ pull: accepted` | This pull request has been merged into the code base. |
| `⚠️ pull: merge conflict` | This pull request has conflicts with the target branch. Those need to be resolved before we can review it. |
| `🔍 pull: ready for review` | This pull request is not in draft mode and is waiting for maintainer review. |
| `❌ pull: rejected` | This pull request was not accepted by maintainers and was closed. |
| `⏫ pull: requires update` | This pull request has had changes requested by the maintainer team. |
| `⚒️ pull: work in progress` | This pull request is in draft mode and is not ready for review. |

58
docs/community/melody.md Normal file
View File

@ -0,0 +1,58 @@
# Melody Iuvo
You may see Melody in our Discord, or responding to issues on GitHub. Melody is a bot, and she serves as our community assistant.
## GitHub
On GitHub, Melody handles the automatic invitation flow for new organisation members.
She also welcomes new contributors, and thanks contributors when a PR is merged.
## Discord
Melody is much more full featured on Discord. She has a number of commands that you can use to interact with the community.
### Assets
All of Naomi's assets can be accessed through Melody. These assets are provided as reference (for things like fan art or commissions).
> [!WARNING]
> Assets may not be repurposed or redistributed without prior permission from Naomi.
These commands are under `/assets`.
### Currency System
Melody manages our community's currency system. This system grants you NaomiCoin for sending messages and interacting with your fellow members. You can use these NaomiCoin to purchase special items, such as a custom colour role or the ability to set Naomi's avatar. You can also gamble for more coin through the slots!
These commands are under `/currency`.
### Frequently Asked Questions
For help with navigating our community, we created a FAQ system with common questions we see. Questions are mainly examples of "Where do I do X?" or "How do I do Y?".
Questions may be added and edited through [GitHub](https://github.com/naomis-novas/melody-iuvo/blob/main/src/config/Faq.ts).
These commands are under `/faq`.
### Fun Commands
There are a couple of commands related to Naomi, which are added just for fun. You can ask Naomi anonymous questions, or generate a quote image with her avatar.
These commands are under `/naomi`.
There is also a `/tarot` command, which allows you to get a daily tarot card reading, and a `/yokai` command, which allows you to get information about a random yokai.
### Plural Systems
Melody allows you to proxy your messages much like PluralKit or Tupperbox. You can set up identities for your alters, configure a prefix, and choose an avatar. You can also set up auto-proxying.
These commands are under `/plural`.
### Streams
Naomi streams on [Twitch](https://twitch.tv/naomilgbt), and Melody has a couple of commands to support this. The `/game` command allows you to fetch a random game from Naomi's library, and the `/queue` command allows you to see Naomi's planned list of games to play on stream.
### Ticket System
Melody also handles the private support ticket system. If you need to create a private discussion with our team, use the Open a Ticket button found in the `#our-work` channel.