Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (42 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

55 lines (42 loc) · 1.42 KB

Contributing Guide

Thank you for your interest in contributing to Widgetify! This document provides guidelines to help you with the contribution process.

Required Tools

To contribute, you'll need to install the following tools and software:

  • Bun.sh
  • Chrome Browser
  • Biomejs

API documentation can be found in the Api-doc.md file.

Getting Started

To get started, fork and clone the repository to your local machine:

git clone https://github.com/widgetify-app/widgetify-extension.git
cd widgetify-extension
bun install
git checkout -b feature/your-feature-name
bun dev

Tip

After running the last command, open a new tab in your browser (the default tab might show a blank page)

How to Contribute

Before submitting a pull request, please make sure the following is done:

  1. Create a new branch for your feature or bug fix.
  2. Make your changes and commit them with descriptive commit messages.
  3. Push your changes to your fork: git push origin my-feature
  4. Create a pull request.

Development Workflow

  • Create a new branch for each feature or fix
  • Sync with the main branch before submitting a pull request
  • Keep your branches clean and focused on a single topic

Code Style Guide

  • Use biomejs for code formatting
  • Variable and function names should be clear and descriptive

Community Communication

Thank you for contributing!