RabbitLabs/vylbot-core
RabbitLabs/vylbot-core
Archived
5
0
Fork 0
Code Issues 33 Pull requests 3 Projects Releases 7 Wiki Activity

Merge pull request #21 from GetGravitySoft/docs/email

Browse source 
Update documentation with a contact email
This commit is contained in:
Vylpes 2020-11-08 17:02:25 +00:00 committed by GitHub
commit 96dba8c84b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CODE_OF_CONDUCT.md
View file

@ -61,7 +61,7 @@ representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD]. getgravitysoftware@gmail.com.
All complaints will be reviewed and investigated promptly and fairly. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the All community leaders are obligated to respect the privacy and security of the

10
CONTRIBUTING.md
View file

@ -12,6 +12,8 @@ This project and everyone participating in it is governed by the VylBot Core Cod
> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below. > **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below.
You can ask a question about the project by emailing us at `getgravitysoftware@gmail.com`.
You can ask a question about the project in the `#development` channel in the [Discord Server](https://discord.gg/UyAhAVp). You can ask a question about the project in the `#development` channel in the [Discord Server](https://discord.gg/UyAhAVp).
## What you should know ## What you should know
@ -30,7 +32,7 @@ There are a few conventions that have developed over time for this project. When
We won't accept pull requests unless these checks pass. If yours fail, simply fix what the bot says until it passes and then get a repo member to review your code. We won't accept pull requests unless these checks pass. If yours fail, simply fix what the bot says until it passes and then get a repo member to review your code.
The rules for the code is based upon [Vylpes' Config Repo](https://github.com/vylpes/config) The rules for the code is based upon [Gravity Software's Config Repo](https://github.com/GetGravitySoft/Config)
* Variable names should use **Camel Case** * Variable names should use **Camel Case**
* Functions should put **braces on the same line** * Functions should put **braces on the same line**
@ -117,8 +119,8 @@ Enhancement suggestions are tracked as GitHub issues. After you've determined th
Unsure where to begin contributing to VylBot Core? You can start by looking through these `good first` and `help wanted` issues: Unsure where to begin contributing to VylBot Core? You can start by looking through these `good first` and `help wanted` issues:
* [Good first issue](https://github.com/vylpes/vylbot-core/labels/good%20first%20issue) - issues which should only require a few lines of code, and a test or two. * [Good first issue](https://github.com/getgravitysoft/vylbot-core/labels/good%20first%20issue) - issues which should only require a few lines of code, and a test or two.
* [Help wanted](https://github.com/vylpes/vylbot-core/labels/help%20wanted) - issues which should be a bit more involved than `good first` issues. * [Help wanted](https://github.com/getgravitysoft/vylbot-core/labels/help%20wanted) - issues which should be a bit more involved than `good first` issues.
#### Prerequisites #### Prerequisites
@ -249,7 +251,7 @@ There are a few conventions that have developed over time for this project. When
We won't accept pull requests unless these checks pass. If yours fail, simply fix what the bot says until it passes and then get a repo member to review your code. We won't accept pull requests unless these checks pass. If yours fail, simply fix what the bot says until it passes and then get a repo member to review your code.
The rules for the code is based upon [Vylpes' Config Repo](https://github.com/vylpes/config) The rules for the code is based upon [Gravity Software's Config Repo](https://github.com/getgravitysoft/config)
* Variable names should use **Camel Case** * Variable names should use **Camel Case**
* Functions should put **braces on the same line** * Functions should put **braces on the same line**

6
README.md
View file

@ -4,7 +4,7 @@ Discord bot client based upon Discord.js
## Installation ## Installation
Download the latest version from the [releases page](https://github.com/Vylpes/vylbot-core/releases). Download the latest version from the [releases page](https://github.com/GetGravitySoft/vylbot-core/releases).
Copy the config template file and fill in the strings. Copy the config template file and fill in the strings.
@ -38,11 +38,11 @@ const client = new vylbot.client(config);
client.start(); client.start();
``` ```
See the [docs](https://github.com/Vylpes/vylbot-core/blob/main/docs/index.md) for more information on how to use vylbot-core See the [docs](https://github.com/GetGravitySoft/vylbot-core/blob/main/docs/index.md) for more information on how to use vylbot-core
## VylBot Essentials ## VylBot Essentials
Want basic commands to add to your bot? Checkout [VylBot Essentials](https://github.com/vylpes/vylbot-essentials)! Want basic commands to add to your bot? Checkout [VylBot Essentials](https://github.com/GetGravitySoft/vylbot-essentials)!
Latest release: `1.0.0` on `3rd November 2020` Latest release: `1.0.0` on `3rd November 2020`