RabbitLabs/random-bunny
5
0
Fork 0
Code Issues 11 Pull requests 11 Projects 1 Releases 18 Wiki Activity Actions

Update documentation #33

Closed
Vylpes wants to merge 1 commit from feature/28-update-documentation-discord-link into hotfix/2.0.2
pull from: feature/28-update-documentation-discord-link
merge into: RabbitLabs:hotfix/2.0.2
Conversation 0 Commits 1 Files changed 3 +22 -22
3 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CODE_OF_CONDUCT.md
View file

@ -60,8 +60,7 @@ representative at an online or offline event.
## Enforcement ## Enforcement
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 [helpdesk@vylpes.com](mailto:helpdesk@vylpes.com).
[INSERT CONTACT METHOD].
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

36
CONTRIBUTING.md
View file

@ -14,6 +14,8 @@ This project and everyone participating in it is governed by the Random Bunny Co
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).
You can also email me at [ethan@vylpes.com](mailto:ethan@vylpes.com) for general queries, or if you require support at [helpdesk@vylpes.com](mailto:helpdesk@vylpes.com)
## What you should know ## What you should know
### Javascript and Node ### Javascript and Node
@ -76,9 +78,9 @@ Include details about your configuration and environment:
* **What's the name and version of the OS you're using?** * **What's the name and version of the OS you're using?**
* **Are you running Random Bunny in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest? * **Are you running Random Bunny in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
* **What version of node do you have installed?** You can get this version by running the `node -v` command in your terminal. * **What version of node do you have installed?** You can get this version by running the `node -v` command in your terminal.
* **What does your `config.json` file look like?** * **What does your `.env` file look like?**
> **Note:** remember to **not** give out your bot tokens which are inside of the `config.json` file. If you're giving a copy of your configuration remember to delete the tokens from the string and leave the empty. > **Note:** remember to **not** give out your bot tokens which are inside of the `.env` file. If you're giving a copy of your configuration remember to delete the tokens from the string and leave the empty.
* **Are you running the bot in live or dev mode?** * **Are you running the bot in live or dev mode?**
@ -132,22 +134,20 @@ If you want to understand how Random Bunny works or want to debug an issue, you'
First, fork the Random Bunny repository so that you can make a pull request. Then, clone your fork locally: First, fork the Random Bunny repository so that you can make a pull request. Then, clone your fork locally:
```bash ```bash
git clone https://gitlab.vylpes.com/<your-gitlab-account>/random-bunny.git git clone https://github.com/<your-gitlab-account>/random-bunny.git
``` ```
Occasionally, you will want to merge changes in the upstream repository (the official code repo) with your fork. Occasionally, you will want to merge changes in the upstream repository (the official code repo) with your fork.
```bash ```bash
cd Random Bunny cd random-bunny
git checkout master git checkout master
git pull https://gitlab.vylpes.com/vylpes/random-bunny.git master git pull https://github.com/vylpes/random-bunny.git master
``` ```
Manage any merge conflicts, commit them, and then push them to your fork. Manage any merge conflicts, commit them, and then push them to your fork.
Go into `Random Bunny` and start the bot in dev mode with `npm run dev` or `node bot dev` Go into `random-bunny` and build using `yarn build`.
> **Note:** If you have `nodemon` installed on your system you can use this during development so it auto restarts when you make code changes. Instead of the commands above you can then run `nodemon bot dev`.
#### Pull Requests #### Pull Requests
@ -309,21 +309,21 @@ Unsure where to begin contributing to Random Bunny? You can start by looking thr
#### Prerequisites #### Prerequisites
In order to download necessary tools, clone the repository, and install dependencies via `npm` you need network access. In order to download necessary tools, clone the repository, and install dependencies via `yarn` you need network access.
You'll need the following tools: You'll need the following tools:
* Git * Git
* NodeJS * NodeJS
* Yarn
Install and build all of the dependencies using `npm` Install and build all of the dependencies using `npm`
```bash ```bash
cd Random Bunny cd random-bunny
npm install yarn install
cp config.json.template config.json
``` ```
And then use your text editor of choice to fill in the `config.json` file. And then use your text editor of choice to fill in the `.env` file.
#### Build and Run #### Build and Run
@ -332,22 +332,20 @@ If you want to understand how Random Bunny works or want to debug an issue, you'
First, fork the Random Bunny repository so that you can make a pull request. Then, clone your fork locally: First, fork the Random Bunny repository so that you can make a pull request. Then, clone your fork locally:
```bash ```bash
git clone https://gitlab.vylpes.com/<your-gitlab-account>/random-bunny.git git clone https://github.com/<your-github-account>/random-bunny.git
``` ```
Occasionally, you will want to merge changes in the upstream repository (the official code repo) with your fork. Occasionally, you will want to merge changes in the upstream repository (the official code repo) with your fork.
```bash ```bash
cd Random Bunny cd random-bunny
git checkout master git checkout master
git pull https://github.com/getgravitysoft/random-bunny.git master git pull https://github.com/vylpes/random-bunny.git master
``` ```
Manage any merge conflicts, commit them, and then push them to your fork. Manage any merge conflicts, commit them, and then push them to your fork.
Go into `Random Bunny` and start the bot in dev mode with `npm run dev` or `node bot dev` Go into `random-bunny` and build using `yarn build`.
> **Note:** If you have `nodemon` installed on your system you can use this during development so it auto restarts when you make code changes. Instead of the commands above you can then run `nodemon bot dev`.
#### Pull Requests #### Pull Requests

5
readme.md
View file

@ -53,7 +53,10 @@ The json string which gets returned consists of:
## Links ## Links
* Discord: [Server Link](https://vylpes.xyz/discord) * Discord: [Server Link](https://discord.gg/UyAhAVp)
* Twitter: [@Vylpes](https://twitter.com/Vylpes)
* Email (General): [ethan@vylpes.com](mailto:ethan@vylpes.com)
* Email (Support): [helpdesk@vylpes.com](mailto:helpdesk@vylpes.com)
## License ## License