diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 1c732eb..4c792a0 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,4 @@ * @TeamOctolings/boyfriend .github/CODEOWNERS @TeamOctolings/boyfriend-admins -*.md @mctaylors +/docs/ @mctaylors Messages.tt-ru.resx @mctaylors diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0b5e0cd --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community 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 community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement via the "Report Content" feature or via email at +l1ttleofficial@outlook.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community 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. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..bcaa25f --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,68 @@ +# Contributing Guidelines + +Thank you for showing interest in the development of Boyfriend. We aim to provide a good collaborating environment for +everyone involved, and as such have decided to list some of the most important things to keep in mind in the process. +Before starting, please read our [Code of Conduct](CODE_OF_CONDUCT.md) + +## Reporting bugs + +A **bug** is a situation in which there is something clearly wrong with the bot. Examples of applicable bug reports are: + +- The bot doesn't reply to a command +- The bot sends the same message twice +- The bot takes a long time to a respond if I use this specific command +- An embed the bot sent has incorrect information in it + +To track bug reports, we primarily use GitHub **issues**. When opening an issue, please keep in mind the following: + +- Before opening the issue, please search for any similar existing issues using the text search bar and the issue + labels. This includes both open and closed issues (we may have already fixed something, but the fix hasn't yet been + released). +- When opening the issue, please fill out as much of the issue template as you can. In particular, please make sure to + include console output and screenshots as much as possible. +- We may ask you for follow-up information to reproduce or debug the problem. Please look out for this and provide + follow-up info if we request it. + +## Submitting pull requests + +While pull requests from unaffiliated contributors are welcome, please note that the core team *may* be focused on +internal issues that haven't been published to the issue tracker yet. Reviewing PRs is done on a best-effort basis, so +please be aware that it may take a while before a core maintainer gets around to review your change. + +The [issue tracker](https://github.com/TeamOctolings/Boyfriend/issues) should provide plenty of issues to start with. +Make sure to check that an issue you're planning to resolve does not already have people working on it and that there +are no PRs associated with it + +In the case of simple issues, a direct PR is okay. However, if you decide to work on an existing issue which doesn't +seem trivial, **please ask us first**. This way we can try to estimate if it is a good fit for you and provide the +correct direction on how to address it. + +If you'd like to propose a subjective change to one of the UI/UX aspects of the bot, or there is a bigger task you'd +like to work on, but there is no corresponding issue yet for it, **please open an issue first** to avoid wasted effort. + +Aside from the above, below is a brief checklist of things to watch out when you're preparing your code changes: + +- Make sure you're comfortable with the principles of object-oriented programming, the syntax of C\# and your + development environment. +- Make sure you are familiar with [git](https://git-scm.com/) + and [the pull request workflow](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests). +- Please do not make code changes via the GitHub web interface. +- Please make sure your development environment respects the .editorconfig file present in the repository. Our code + style differs from most C\# projects and is closer to something you see in Java projects. +- Please test your changes. We expect most new features and bugfixes to be tested in an environment similar to + production. + +After you're done with your changes and you wish to open the PR, please observe the following recommendations: + +- Please submit the pull request from + a [topic branch](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#_topic_branch) (not `master`), and + keep the *Allow edits from maintainers* check box selected, so that we can push fixes to your PR if necessary. +- Please avoid pushing untested or incomplete code. +- Please do not force-push or rebase unless we ask you to. +- Please do not merge `master` continually if there are no conflicts to resolve. We will do this for you when the change + is ready for merge. + +We are highly committed to quality when it comes to Boyfriend. This means that contributions from less experienced +community members can take multiple rounds of review to get to a mergeable state. We try our utmost best to never +conflate a person with the code they authored, and to keep the discussion focused on the code at all times. Please +consider our comments and requests a learning experience. diff --git a/.github/README.md b/docs/README.md similarity index 67% rename from .github/README.md rename to docs/README.md index ee86305..c967562 100644 --- a/.github/README.md +++ b/docs/README.md @@ -11,10 +11,13 @@ ![GitHub License](https://img.shields.io/github/license/TeamOctolings/Boyfriend) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/TeamOctolings/Boyfriend/.github/workflows/resharper.yml?branch=master) ![GitHub last commit](https://img.shields.io/github/last-commit/TeamOctolings/Boyfriend) +![CodeFactor](https://img.shields.io/codefactor/grade/github/TeamOctolings/Boyfriend) -Beep! I'm a general-purpose bot for moderation written by [@Octol1ttle](https://github.com/Octol1ttle) in C# and Discord.Net +Beep! I'm a general-purpose bot for moderation written by [@Octol1ttle](https://github.com/Octol1ttle) in C# and +Discord.Net + +## Features -# Features * Banning, muting, kicking, etc. * Reminding you about something if you wish * Reminding everyone about that new event you made @@ -22,6 +25,13 @@ Beep! I'm a general-purpose bot for moderation written by [@Octol1ttle](https:// *...and more!* -# Getting Started +## 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. +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.