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

Update documentation with up to date information

Browse source
This commit is contained in:
Ethan Lane 2022-08-18 17:45:05 +01:00
parent ee4f1873d1
commit 57ab01c2cf
Signed by: Vylpes
GPG key ID: EED233CC06D12504
4 changed files with 36 additions and 25 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]. [helpdesk@vylpes.com](mailto:helpdesk@vylpes.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

47
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 with queries and support if you'd prefer at [helpdesk@vylpes.com](mailto:helpdesk@vylpes.com).
## What you should know ## What you should know
### Javascript and Node ### Javascript and Node
@ -115,13 +117,13 @@ 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 `config.json` file.
@ -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://gitea.vylpes.xyz/<your-gitea-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://gitea.vylpes.xyz/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 the package 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
@ -169,6 +169,11 @@ Please follow these steps to have your contribution considered by maintainers:
While the prerequesites above must be satisifed prior to having your pull reuqest accepted, the reviewer(s) may ask you to complete additional design ork, tests, or other changes before your pull request can be ultimately accepted. While the prerequesites above must be satisifed prior to having your pull reuqest accepted, the reviewer(s) may ask you to complete additional design ork, tests, or other changes before your pull request can be ultimately accepted.
#### Submitting Changes via Email
If you're not within our gitea instance and still like to contribute, you can send us your contributions to [git@vylpes.com](mailto:git@vylpes.com).
For more information on how to do this, see the [git documentation](https://git-scm.com/docs/git-send-email).
#### JavaScript Styleguide #### JavaScript Styleguide
All JavaScript code is linted with `eslint`. All JavaScript code is linted with `eslint`.
@ -309,21 +314,20 @@ 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 `yarn`
```bash ```bash
cd Random Bunny cd random-bunny
npm install npm install
cp config.json.template config.json
``` ```
And then use your text editor of choice to fill in the `config.json` file.
#### Build and Run #### Build and Run
@ -332,22 +336,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://gitea.vylpes.xyz/<your-gitea-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://gitea.vylpes.xyz/RabbitLabs/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 the package 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
@ -369,6 +371,11 @@ Please follow these steps to have your contribution considered by maintainers:
While the prerequesites above must be satisifed prior to having your pull reuqest accepted, the reviewer(s) may ask you to complete additional design ork, tests, or other changes before your pull request can be ultimately accepted. While the prerequesites above must be satisifed prior to having your pull reuqest accepted, the reviewer(s) may ask you to complete additional design ork, tests, or other changes before your pull request can be ultimately accepted.
#### Submitting Changes via Email
If you're not within our gitea instance and still like to contribute, you can send us your contributions to [git@vylpes.com](mailto:git@vylpes.com).
For more information on how to do this, see the [git documentation](https://git-scm.com/docs/git-send-email).
#### JavaScript Styleguide #### JavaScript Styleguide
All JavaScript code is linted with `eslint`. All JavaScript code is linted with `eslint`.

9
package.json
View file

@ -1,6 +1,6 @@
{ {
"name": "random-bunny", "name": "random-bunny",
"version": "2.0.1", "version": "2.0.2",
"description": "Get a random subreddit image url", "description": "Get a random subreddit image url",
"license": "MIT", "license": "MIT",
"author": "Vylpes", "author": "Vylpes",
@ -26,8 +26,11 @@
"test": "echo none", "test": "echo none",
"lint": "eslint ." "lint": "eslint ."
}, },
"bugs": "https://github.com/Vylpes/random-bunny/issues", "bugs": {
"homepage": "https://github.com/Vylpes/random-bunny", "url": "https://gitea.vylpes.xyz/RabbitLabs/random-bunny/issues",
"email": "helpdesk@vylpes.com"
},
"homepage": "https://gitea.vylpes.xyz/RabbitLabs/random-bunny",
"funding": "https://ko-fi.com/vylpes", "funding": "https://ko-fi.com/vylpes",
"devDependencies": { "devDependencies": {
"@types/node": "^16.11.11", "@types/node": "^16.11.11",

3
readme.md
View file

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