Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 1.77 KB

Firstly, thank you for being interested in contributing to BEE7! Please read the following fully in order to understand how to contribute.

How do I create a new branch/pull request?

Do the following:

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Make sure to add credit to yourself in the command!

I want everyone to get the credit they deserve. If you don't, I will literally not merge the pull request until you add credit somewhere.

Is there a specific commit style I should use?

Yes, we use commit-lint to verify commit messages. Example for adding a feature: feat(NickCommand): add nickname command. The capitilization matters, it will not commit if you do not follow it

How do I make new commands?

Use this template:

import { Message } from "discord.js";
import { CustomCommand } from "../../classes/Command";

export default class CmdNameCommand extends CustomCommand {
    public constructor() {
        super("cmdname", {
            // THE FIRST ELEMENT MUST BE THE EXACT COMMAND NAME OTHERWISE IT WILL BREAK
            aliases: ["cmdname"],
            category: "category",
            description: {
                content: "Description",
                usage: "usage",
                examples: ["example"],
            },
        });
    }

    public exec(message: Message): Promise<Message> {
        // Some amazing code here
    }
}

What should I include in the pull request?

Please include the following:

  • What the pull request adds
  • Why you think the pull request is necessary
  • Does it include any breaking changes (changed args pattern, command names, etc)?