Skip to content

Commit

Permalink
🖥️
Browse files Browse the repository at this point in the history
feat: Added two new .md files, including a readme and contributing guide!
  • Loading branch information
notaestheticallyducko committed Aug 8, 2023
1 parent 9a7d0c6 commit 57f7f64
Show file tree
Hide file tree
Showing 2 changed files with 105 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Contributing

Contributions are more than welcome! If you have ideas for new features, improvements, or bug fixes, feel free to open an issue or submit a pull request. To ensure a smooth collaboration process, please follow these guidelines:

1. **Fork** the repository.
2. Create a new branch for your feature/bugfix: `git checkout -b feature-name`.
3. Make your changes and commit them: `git commit -m "Add some feature"`.
4. Push your changes to the branch: `git push origin feature-name`.
5. Open a pull request against the `main` branch.

Please make sure your pull request includes:

- A clear and concise description of the changes.
- Any relevant documentation updates.
- Tests if applicable (maintaining test coverage helps a lot!).
- Make sure your code follows the project's coding style and conventions.

## Code Style

We follow the [ConventionalCommits](https://www.conventionalcommits.org/en/v1.0.0/) for our code. Please ensure your contributions adhere to this style.

## Issue Reporting

If you encounter any issues or bugs, please [open an issue](https://github.com/gvobot/bot/issues) and provide detailed information about the problem. Include steps to reproduce, your operating system, and any relevant error messages.

## License

By contributing to this project, you agree that your contributions will be licensed under the [MIT License](LICENSE).

We're excited to see your contributions! Thanks for making AwesomeBot even more awesome!
75 changes: 75 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# GVO Discord Bot

[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-orange.svg)](https://sonarcloud.io/summary/new_code?id=gvobot_bot)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J1FVEH0)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=gvobot_bot&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=gvobot_bot)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=gvobot_bot&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=gvobot_bot)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=gvobot_bot&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=gvobot_bot)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=gvobot_bot&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=gvobot_bot)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=gvobot_bot&metric=bugs)](https://sonarcloud.io/summary/new_code?id=gvobot_bot)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=gvobot_bot&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=gvobot_bot)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=gvobot_bot&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=gvobot_bot)

Welcome to the repository for GVO - the coolest Discord bot out there! This bot is designed to add a touch of awesomeness to your server, bringing in a range of fun and useful features that will surely enhance your Discord experience.

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Introduction

GVO is a Discord bot built using [Discord.js](https://discord.js.org/), designed to make your server interactions more engaging and entertaining. It's developed with a focus on simplicity, customization, and of course, awesomeness.

## Features

- **Random Quotes**: Spice up the conversation with random quotes on daily basis.
- **Social Media**: Get notified when your favorite streamer goes live!
- **Polls**: Conduct polls among your server members to gather opinions quickly.
- **Moderation Tools**: Keep your server in check with built-in auto-moderation.
- **And More!**: Explore the bot to discover even more awesome features.

## Installation

To invite GVO to your server, simply click [here](https://discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID&scope=bot&permissions=YOUR_PERMISSIONS) and authorize the bot with the necessary permissions. Replace `YOUR_CLIENT_ID` with your bot's client ID and `YOUR_PERMISSIONS` with the permissions you want to grant.

If you want to host the bot yourself, follow these steps:

1. Clone the repository: `git clone https://github.com/gvobot/bot.git`
2. Navigate to the bot's directory: `cd bot`
3. Install the required dependencies: `npm install`
4. Configure the bot token in `.env`
5. Rename `example.env` to `.env`
6. Run the bot: `npm start`

## Usage

Once GVO is in your server, you can use various commands to unleash its awesomeness:

- `/help`: Display the list of available commands and how to use them.

## Contributing

Contributions are more than welcome! If you have ideas for new features, improvements, or bug fixes, feel free to open an issue or submit a pull request. Please read our [Contribution Guidelines](CONTRIBUTING.md) before getting started.

## Contributors

Thanks to the following contributors who have made this project possible:

<a href="https://github.com/gvobot/bot/graphs/contributors">
<img src="https://stg.contrib.rocks/image?repo=gvobot/bot" alt="Contributors" />
</a>

## License

GVO is released under the [MIT License](LICENSE), which means you can use, modify, and distribute it freely. We appreciate attribution if you include a link back to the repository.

---

Thank you for choosing GVO! We hope you enjoy using it as much as we enjoyed creating it. If you have any questions or need assistance, join our [support server](https://gvobot.app/discord) for help. Have an awesome time with GVO! 🎉

0 comments on commit 57f7f64

Please sign in to comment.