From 6741a354d56463165dcd9d2f056fe58025a149b4 Mon Sep 17 00:00:00 2001 From: g <83366426+bbpltergiest@users.noreply.github.com> Date: Sun, 8 Feb 2026 13:13:39 -0300 Subject: [PATCH] feat(docs): some better wording (#747) Co-authored-by: thororen1234 <78185467+thororen1234@users.noreply.github.com> Co-authored-by: sankoofa <83366426+sankoofa@users.noreply.github.com> --- CODE_OF_CONDUCT.md | 19 +++++++------- CONTRIBUTING.md | 64 ++++++++++++++++++++++++++-------------------- 2 files changed, 45 insertions(+), 38 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index dfcdbf1ca..5366a23c1 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -4,20 +4,19 @@ Our community is welcoming to everyone, regardless of their characteristics. As such, we expect you to treat everyone with respect and contribute to an open and welcoming community. -DO +**DO:** -- have empathy and be nice to others -- be respectful of differing opinions, even if you disagree -- give and accept constructive criticism +- Have empathy and be nice to others. +- Be respectful of differing opinions, even if you disagree. +- Hive and accept constructive criticism. -DON'T +**DON'T:** -- use offensive or derogatory language -- troll or spam -- personally attack or harass others +- Use offensive or derogatory language. +- Troll or spam. +- Personally attack or harass others. Repetitive violations of these guidelines might get your access to the repository restricted. If you feel like a user is violating these guidelines or feel treated unfairly, please refrain from vigilantism -and instead report the issue to a moderator! The best way is joining our [official Discord community](https://equicord.org/discord) -and opening a modmail ticket. +and instead report the issue to a moderator! The best way is joining our [official Discord community](https://equicord.org/discord) and opening a modmail ticket. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9bc1e9616..d64831329 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,51 +1,59 @@ -# Contributing to Equicord +# Introduction Equicord is a community project and welcomes any kind of contribution from anyone! We have development documentation for new contributors, which can be found at . -All contributions should be made in accordance with our [Code of Conduct](./CODE_OF_CONDUCT.md). +> [!IMPORTANT] +> All contributions must follow our [Code of Conduct](./CODE_OF_CONDUCT.md). ## How to contribute -Contributions can be sent via pull requests. If you're new to Git, check [this guide](https://opensource.com/article/19/7/create-pull-request-github). +Contributions are submitted through pull requests. If you are new to Git or GitHub, we recommend reading [this guide](https://opensource.com/article/19/7/create-pull-request-github). -Pull requests can be made either to the `main` or the `dev` branch. However, unless you're an advanced user, I recommend sticking to `main`. This is because the dev branch might contain unstable changes and be force pushed frequently, which could cause conflicts in your pull request. +Pull requests can target either the `main` or `dev` branch. +Unless you are experienced and know what you are doing, **always target `main`**. The `dev` branch may contain unstable changes and can be force-pushed frequently, which may break your pull request. -## Write a plugin +## Writing a Plugin -Writing a plugin is the primary way to contribute. +Developing a plugin is the primary way to contribute. Before starting your plugin: -- Be in our discord -- Check existing pull requests to see if someone is already working on a similar plugin -- Check our [plugin requests tracker](https://discord.com/channels/1173279886065029291/1419347113745059961) to see if there is an existing request, or if the same idea has been rejected -- If there isn't an existing request, [open one](https://discord.com/channels/1173279886065029291/1419347113745059961) yourself. - and include that you'd like to work on this yourself. Then wait for feedback to see if the idea even has any chance of being accepted. Or maybe others have some ideas to improve it! -- Familarise yourself with our plugin rules below to ensure your plugin is not banned +- Join our Discord server. +- Check existing pull requests to avoid duplicate work. +- Check the [plugin requests tracker](https://discord.com/channels/1173279886065029291/1419347113745059961) to see if your idea already exists or was rejected. +- If no request exists, open one and clearly state that you want to work on it yourself. +- Wait for feedback before starting development, as some ideas may not be accepted or may need adjustments. +- Familiarize yourself with the plugin rules below. -### Plugin Rules +> [!WARNING] +> Skipping these steps may result in your plugin being rejected, even if it is technically correct. -- No simple slash command plugins like `/cat`. Instead, make a [user installable Discord bot](https://discord.com/developers/docs/change-log#userinstallable-apps-preview) -- No simple text replace plugins like Let me Google that for you. The TextReplace plugin can do this -- No raw DOM manipulation. Use proper patches and React -- No FakeDeafen or FakeMute -- No StereoMic -- No plugins that simply hide or redesign ui elements. This can be done with CSS -- No plugins that interact with specific Discord bots (official Discord apps like Youtube WatchTogether are okay) -- No selfbots or API spam (animated status, message pruner, auto reply, nitro snipers, etc) -- No untrusted third party APIs. Popular services like Google or GitHub are fine, but absolutely no self hosted ones -- No plugins that require the user to enter their own API key -- Do not introduce new dependencies unless absolutely necessary and warranted +## Plugin Rules -## Improve Equicord itself +To keep Equicord stable, secure and maintainable, all plugins must follow these rules: +1. No simple slash-command plugins (e.g. `/cat`). If applicable, create a [user-installable Discord app](https://discord.com/developers/docs/change-log#userinstallable-apps-preview) instead. +2. No simple text replacement plugins (the built-in TextReplace plugin already covers this). +3. No raw DOM manipulation — always use proper patches and React. +4. No FakeDeafen or FakeMute functionality. +5. No StereoMic-related plugins. +6. No plugins that only hide or redesign UI elements (use CSS for that). This rule may be negotiable. +7. No plugins that interact with specific third-party Discord bots (official Discord apps are allowed). +8. No selfbots or API abuse (auto-replies, animated statuses, message pruning, Nitro snipers, etc.). +9. No untrusted third-party APIs (well-known services like Google or GitHub are acceptable). +10. No plugins that require users to provide their own API keys. +11. Do not introduce new dependencies unless they are strictly necessary and well justified. -If you have any ideas on how to improve Equicord itself, or want to propose a new plugin API, feel free to open a feature request so we can discuss. +**Plugins that violate any of these rules will not be accepted.** -Or if you notice any bugs or typos, feel free to fix them! +## Improving Equicord Itself -## Help out users in our Discord community +If you want to improve Equicord beyond plugins, such as internal features or performance improvements, you are welcome to open a feature request so it can be discussed. + +Bug fixes, refactors, and documentation improvements are also highly appreciated! + +## Helping the Community We have an open support channel in our [Discord community](https://equicord.org/discord). Helping out users there is always appreciated! The more, the merrier.