Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

68 lines (42 loc) · 2.5 KB

Contributing to CommandKit

Firstly, thank you for considering contributing to CommandKit! Whether you're looking to fix bugs, add new features, or just ask questions, your input is valuable to us. Before actually opening a pull request, we recommend that you first open an issue (or check existing ones) to discuss the feature/bug you intend to add/fix.

Setup

Prerequisites

  1. Ensure you have Node.js and pnpm installed.
    • Node.js: Download here
    • pnpm: Install via npm install -g pnpm if you haven't.

Fork & Clone

  1. Fork the repository to your own GitHub account.
  2. Clone your fork to your local machine:
git clone https://github.com/underctrl-io/commandkit.git

Installing Dependencies

Since we use pnpm workspaces, it's essential to use pnpm for installing dependencies.

cd commandkit
pnpm install # Make sure to run this from the root directory

Workflow

  1. Create a new branch for your work:
git checkout -b your-feature-or-bugfix

  1. Make your changes. Please make sure to use the Prettier extension for consistent formatting and comments wherever necessary.

  2. Ensure that your changes don't break any existing functionality. You can test the functionality of your code depending on where you've made changes:

    1. If you've made changes to the CommandKit package, you can use the "apps/test-bot" project to test your own bot. Just make sure to create a new .env file with the template from the .env.example file provided. This also requires you to build the commandkit package locally (after you make your changes) because it's symlinked with pnpm workspaces.
    2. If you've made changes to the docs, you can run pnpm dev inside "apps/docs" to spin up a local development server.

  3. Run pnpm lint from the root directory to ensure all lint scripts and formatting is valid.

  4. Commit your changes:

git commit -m "Describe your change here"
  1. Push your changes to your fork:
git push origin your-feature-or-bugfix
  1. Open a pull request in the main project repository (main branch). Describe your changes and any relevant information.

Submitting Issues

When submitting a new issue, please provide a detailed description of the problem, steps to reproduce it, and any relevant screenshots or error messages.

Thank you for making CommandKit better! We appreciate your effort and look forward to collaborating with you.