Skip to content
This repository was archived by the owner on Sep 1, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (41 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

66 lines (41 loc) · 2.18 KB
Raw

Contributing to UnoWarp Extensions

Thank you for your interest in contributing! This document outlines the process for contributing to this project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

Getting Started

Before contributing, make sure you have the project set up locally. See the README for installation instructions.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue and include:

  • A clear, descriptive title
  • Steps to reproduce the problem
  • What you expected to happen, and what actually happened
  • The version of the software you are using, and your operating system

Before opening a new issue, please check whether one already exists for the problem you are experiencing.

Suggesting Features

Feature suggestions are welcome. Please open an issue and include:

  • A clear, descriptive title
  • A detailed description of the proposed feature and the problem it solves
  • Any alternatives you have considered

Submitting Changes

  1. Fork the repository and create a branch from main:

    git switch -c your-feature-or-fix

  2. Make your changes and ensure the project still builds and any tests pass.

  3. Commit your changes following the commit message guidelines below.

  4. Push your branch and open a pull request against main.

  5. A maintainer will review your pull request. Please be responsive to any feedback.

Pull requests that introduce large or breaking changes should be discussed in an issue first.

Style Guidelines

Please follow the configured tooling before opening a pull request:

npm run lint
npm run format:check

If you add or modify extension files under src/extensions/**/*.js, ensure they satisfy the custom extension rules in eslint.config.mjs.

Commit Messages

Please follow these conventions when writing commit messages:

  • Use the present tense and imperative mood: "Add feature", not "Added feature" or "Adds feature"
  • Keep the subject line to 72 characters or fewer
  • Reference relevant issues or pull requests where applicable (e.g. Closes #42)