Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

86 lines (54 loc) · 2.81 KB
Raw

How to Contribute to Botkube

We'd love your help!

Botkube is MIT Licensed and accepts contributions via GitHub pull requests. This document outlines conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contributions accepted.

Prerequisite

  • Node.js 16

  • (Optional) NVM for managing multiple Node.js installations

  • Docusaurus

  • Magefile

    Note Run mage -l to see all possible targets.

  • Cloned Botkube documentation repository

    Use the following command to clone it:

    git clone https://github.com/kubeshop/botkube-docs.git

    Note To learn how to do it, follow the Contribute section in the Git workflow guide.

Build the site locally

Follow the instructions to clone this repository and build the docs locally.

  • Clone the repository

    git clone https://github.com/kubeshop/botkube-docs
cd botkube-docs

  • Install dependencies

    npm install

  • Start local server

    npm run start

    Site can be viewed at http://localhost:3000.

Making A Change

Before making any significant changes, please open an issue. Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.

Adding a new documentation page

Create a Markdown file and place it under the docs/ directory. More info how to do it can be found in Docusaurus documentation Create a doc

Modifying an existing documentation page

Find the documentation page file (.md/mdx file) under docs/ and edit it.

Publishing your changes

Create a Pull Request with your changes. When the PR is merged site will be updated automatically. Make sure your pull request has good commit messages:

  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain what and why instead of how

Try to squash unimportant commits and rebase your changes on to the main branch, this will make sure we have clean log of changes.

Support Channels

Join the Botkube-related discussion on Slack!

Create your Slack account on Botkube workspace.

To report bug or feature, use GitHub issues.