random-bunny/CONTRIBUTING.md

Contributing to Random Bunny

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Random Bunny. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Random Bunny Code of Conduct. By participating, you are expected to uphold this code.

Questions about Random Bunny

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 in the #development channel in the Discord Server.

You can also email with queries and support if you'd prefer at helpdesk@vylpes.com.

What you should know

Javascript and Node

Random Bunny uses NodeJS, and therefore Javascript, as its runtime. You should know how to use this.

Conventions

There are a few conventions that have developed over time for this project. When you create a pull request a check will be ran making sure that your code follows these conventions.

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.

• Variable names should use Camel Case
• Functions should put braces on the same line
• No comma dangle, i.e. having a commma after the last item in an object
• Arrow body style should have braces around the body only when needed
• Arrow parameters should have brackets around them only when needed
• Arrow spacing should have a space around the arrow (' => ')
• No var should be used, instead use either let or const when appropriate

How You Can Contribute

Reporting Bugs

This section guides you through submitting a bug report for Random Bunny. Following these guidelines helps maintainers and the community understand your report. reproduce the behaviour, and find related reports.

When you are creating a bug report, please include as many details as possible.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting A Bug Report

• Perform a search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How You Can Submit A (Good) Bug Report

Bugs are tracked as GitHub issues. After you've determined the bug you're reporting hasn't got a pre-existing open issue already, create an issue and provide information from below.

• Use a clear and descriptive title for the issue to indentify the problem.
• Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Random Bunny (if you're using your own instance), which command exactly you used, and the output which the bot replied with. If its your own instance, provide information on what the terminal output said, if any.
• Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pastable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
• Describe the behaviour you observed after following the steps and point out what exactly is the problem with that behaviour.
• Explain which behaviour you expected to see instead and why.
• Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
• If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

• Did the problem start happening recently (e.g. after updating to a new version of Random Bunny) or was this always a problem?
• If the problem started happening recently, can you reproduce the problem in an older version of Random Bunny? What's the most recently version in which the problem doesn't happen? You can download older versions of Random Bunny from the releases page.
• Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

• Which version of Random Bunny are you using? You can get the exact version by running the about command.
• 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?
• What version of node do you have installed? You can get this version by running the node -v command in your terminal.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Random Bunny, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

When you are creating an enhancement suggestion, please include as many details as possible. Fill out the suggestion with the steps that you imagine you would take if the feature you're requesting existed.

Before Submitting an Enhancement Suggestion

• Check if the feature already exists. Make sure to check on the latest version
• Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. After you've determined the feature doesn't already exist or been suggested before, create an issue on that repository and provide the following information:

• Use a clear and descriptive title for the issue to identify the suggestion.
• Provide a step-by-step description of the suggested enhancement in as many details as possible.
• Provide specific examples to demonstrate the steps. Include copy/pastable snippets which you use in those examples, as Markdown code blocks.
• Describe the current behaviour and explain which behaviour you expected to see instead and why.
• Include screnshots and animated GIFs which help you demonstrate the steps or point out the part of Random Bunny which the suggestion is related to.
• Explain why this enhancement would be useful to most Random Bunny users and isn't something that can or should be implemented as a custom command.
• List some other bots where this enhancement exists.
• Specify which version of Random Bunny you're using. You can get the exact version by running the about command.
• Specify the name and version of the OS you're using.

Prerequisites

In order to download necessary tools, clone the repository, and install dependencies via npm you need network access.

You'll need the following tools:

• Git
• NodeJS
• Yarn

Install and build all of the dependencies using npm

cd random-bunny
yarn install

Build and Run

If you want to understand how Random Bunny works or want to debug an issue, you'll want to get the source, build it, and run the tool locally.

First, fork the Random Bunny repository so that you can make a pull request. Then, clone your fork locally:

git clone https://gitea.vylpes.xyz/<your-gitea-account>/random-bunny.git

# OR

git clone https://codeberg.org/vylpes/random-bunny.git

Occasionally, you will want to merge changes in the upstream repository (the official code repo) with your fork.

cd random-bunny
git checkout 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.

Go into random-bunny and build the package using yarn build.

Pull Requests

The process described here has several goals:

• Maintain Random Bunny's quality
• Fix problems that are important to users
• Engage the community in working toward the best possible Random Bunny
• Enable a sustainable system for Random Bunny's maintainers to review contributions

Please follow these steps to have your contribution considered by maintainers:

• You mention the issue id which this pull request aims to fix
• After you submit your pull request, verify that all status checks are passing.

Note

: If a check fails the pull request it is important that you go and fix these issues, or let us know that you no longer want to work on this issue by commenting on the pull request. Doing this will give you a better chance of having your pull request merged.

• When the checks have passed a maintainer will review your code and ask for any improvements or questions, and will merge it if they are satisifed.

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.

For more information on how to do this, see the git documentation.

Submitting Changes via Codeberg

This code is mirrored on codeberg, although main development is done on my self-hosted Gitea instance, feel free to clone and create pull requests on there. I will merge it back into Gitea once accepted.

JavaScript Styleguide

All JavaScript code is linted with eslint.

• Prefer camelcase for variable names
• Prefer braces { to be on the same line
• Prefer no comma , dangle
• Prefer arrow function bodies to have brances {} only when needed
• Prefer arrow function parameters to have brackets () only when needed
• Prefer arrow function arrows => to have a space before and after it
• Prefer let and const over var

As well as eslint's recommended defaults.

Example

function ban (member) {
    let reason = "Example reason";

    member.ban(reason).then(() => {
        // handle then here
    }).catch(err => {
        // handle error here
    });
}

Contributing to Random Bunny

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Random Bunny. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Random Bunny Code of Conduct. By participating, you are expected to uphold this code.

Questions about Random Bunny

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 in the #development channel in the Discord Server.

What you should know

Javascript and Node

Random Bunny uses NodeJS, and therefore Javascript, as its runtime. You should know how to use this.

Conventions

There are a few conventions that have developed over time for this project. When you create a pull request a check will be ran making sure that your code follows these conventions.

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.

• Variable names should use Camel Case
• Functions should put braces on the same line
• No comma dangle, i.e. having a commma after the last item in an object
• Arrow body style should have braces around the body only when needed
• Arrow parameters should have brackets around them only when needed
• Arrow spacing should have a space around the arrow (' => ')
• No var should be used, instead use either let or const when appropriate