mirror of
https://github.com/TeamOctolings/Octobot.git
synced 2025-01-31 09:09:00 +03:00
Octol1ttle
3eb17b96c5
The project structure has been changed because the previous one had everything in 1 folder. From this PR onwards, the following is true: - The source code is stored in `src/` - `*.resx` and `Messages.Designer.cs` is stored in `locale/` - Documentation is stored on the wiki and in `docs/` - Miscellaneous files, such as dotfiles, are stored in the root folder of the repository This PR additionally fixes an issue that would cause logs of edited messages to not be syntax highlighted. This happened because the responder of edited messages was changed to use the universal `InBlockCode` extension method which did not support syntax highlighting until this PR This PR additionally changes CODEOWNERS to be more reliable. Previously, it would be possible for some PRs to be unable to be approved because the only person who can approve them is the same person who opened the PR. --------- Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com>
48 lines
2.3 KiB
Markdown
48 lines
2.3 KiB
Markdown
<picture>
|
|
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/95250141/206895339-ef5510c8-8b30-4887-b89c-5dc14a24b18a.png">
|
|
|
|
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/95250141/206895340-3415d97d-91fd-4fb6-8c17-4e1bf340e1df.png">
|
|
|
|
<img alt="Boyfriend Logo" src="https://user-images.githubusercontent.com/95250141/206895339-ef5510c8-8b30-4887-b89c-5dc14a24b18a.png">
|
|
|
|
</picture>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Beep! I'm a general-purpose bot for moderation written by [@Octol1ttle](https://github.com/Octol1ttle) in C# and
|
|
Remora.Discord
|
|
|
|
## Features
|
|
|
|
* Banning, muting, kicking, etc.
|
|
* Reminding you about something if you wish
|
|
* Reminding everyone about that new event you made
|
|
* Log everything from joining the server to deleting messages
|
|
|
|
*...and more!*
|
|
|
|
## Installing and running Boyfriend
|
|
|
|
You can read our [wiki](https://github.com/TeamOctolings/Boyfriend/wiki) in order to assemble your Boyfriend™ and
|
|
moderate the server.
|
|
|
|
## Contributing
|
|
|
|
When it comes to contributing to the project, the two main things you can do to help out are reporting issues and
|
|
submitting pull requests. Please refer to the [contributing guidelines](CONTRIBUTING.md) to understand how to help in
|
|
the most effective way possible.
|
|
|
|
## Special Thanks
|
|
|
|
|
|
|
|
[JetBrains](https://www.jetbrains.com/), creators of [ReSharper](https://www.jetbrains.com/resharper)
|
|
and [Rider](https://www.jetbrains.com/rider), supports Boyfriend with one of
|
|
their [Open Source Licenses](https://jb.gg/OpenSourceSupport).
|
|
Rider is the recommended IDE when working with Boyfriend, and everyone on the Boyfriend team uses it.
|
|
Additionally, ReSharper command-line tools made by JetBrains are used for status checks on pull requests to ensure code
|
|
quality even when not using ReSharper or Rider.
|