Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (49 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

62 lines (49 loc) · 1.52 KB

Contributing to Ruckus

Thanks for your interest in contributing! Here's how to get started.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/<your-username>/ruckus-bot.git
cd ruckus-bot
  3. Install dependencies: 
    npm install
  4. Create a .env file from the template: 
    cp .env.example .env
  5. Fill in your bot token, client ID, and guild ID.

Making Changes

  1. Create a feature branch from main: 
    git checkout -b feature/your-feature-name
  2. Make your changes — each command lives in its own file under src/.
  3. Test locally by running the bot: 
    npm start
  4. Deploy commands to your test server: 
    npm run deploy

Submitting a Pull Request

  1. Push your branch to your fork.
  2. Open a Pull Request against the main branch.
  3. Describe what your PR does and why.
  4. Wait for review — we'll try to get back to you quickly!

Code Style

  • Use ES Modules (import/export).
  • One command per file in src/.
  • Export a slash command builder and a handler function from each command file.
  • Register your command in src/deploy-commands.js and wire the handler in src/index.js.

Reporting Bugs

Open an Issue with:

  • Steps to reproduce
  • Expected vs. actual behavior
  • Node.js + discord.js versions

Code of Conduct

Be respectful and constructive. We're all here to build something cool.