Skip to content

Latest commit

 

History

History
83 lines (45 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

83 lines (45 loc) · 2.26 KB
Raw

Contributing to AvBot

First of all, thank you for considering contributing. It helps a lot and helps remove some of the burden from our developer team.

This file will assist you with everything you need to know about setting up a AvBot development/testing environment, writing code that will be approved, and submitting your code.

Setting up a development/testing environment

In order to work on AvBot, you need a working development environment.

Step 1: Prerequisites

AvBot has some prerequisites that need to be met in order to test your new features.

Node.js

For AvBot to function, you need to install the Node.js JavaScript Runtime.

Install version 16.x.x..

NPM

NPM comes built in with Node.js, so there isn't a need to worry about it.

Step 2: Installing dependencies

Now, run the command npm install in your terminal. This will install all of our dependencies.

Writing code that will be approved

When you write your code, it should be fit enough to be merged.

Your code should be formatted with Prettier after you write it, if you don't then a bot will detect your pull request and do that for you.

Code should be reasonable, and we think you are able to understand what that means.

Submitting your code

WARNING

Ensure you are on your fork before continuing. Create one on GitHub.

Step 1: Commiting

Run the following command:

git commit -m "Describe your changes here. Try to use less than 50 characters."

# Or, for an extended description:

git commit -m "Describe your changes here. Try to use less than 50 characters.

Put your extended description here."

Step 2: Pushing

Push to your fork with this command:

git push

If you get a "cannot find upstream branch" error, run

git push --set-upstream origin master

Step 3: Creating a Pull Request

On GitHub, select Pull Requests and open a new one.

Step 3.1: Fill out the template

Fill out our Pull Request template.

Put useful information about the changes there.

Step 4: All done

Your changes will be reviewed soon. Keep an eye on your pull request!