Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
111 lines (70 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

111 lines (70 loc) · 3.03 KB
Raw

Contributing Guidelines

First of all, thank you for your interest in contributing to this project!

We welcome all kinds of contributions, including bug reports, feature requests, documentation improvements, code contributions, and feedback.

Before You Start

Before opening an issue or pull request, please:

  • Read the README.
  • Search existing issues and pull requests.
  • Make sure your idea or bug report has not already been discussed.

Ways to Contribute

Reporting Bugs

If you find a bug, please open an issue and fill out the bug report template.

Suggesting Features

Feature requests are welcome too.

Please open an issue and fill out the feature request template.

Always make sure to have a good title and to properly fill out the required fields!

Improving Documentation

Documentation improvements are often the easiest way to contribute.

Examples include:

  • Fixing typos
  • Clarifying explanations
  • Adding examples
  • Improving setup instructions

Development Workflow

  1. Fork the repository.
  2. Create a new branch:
git checkout -b feature/my-feature
  1. Make your changes.
  2. Test your changes and build using npm run dist:{target filetype}
  3. Commit your changes.
  4. Push your branch.
  5. Open a Pull Request.

Coding Standards

Please follow the existing code style and project structure.

General guidelines:

  • Write clean and maintainable code.
  • Keep changes focused and minimal.
  • Avoid unrelated refactoring.
  • Try to keep comments short to prevent tldr situations.

AI

  • AI may be used as assistance when writing text or code.
  • That usage should be disclosed when submitting a PR.
  • You should ALWAYS understand the code you are submitting.
  • Do NOT create Issues or PRs solely created by AI, always review and make changes yourself.
  • Commits authored or co-authored by AI agent accounts will NOT be accepted/merged.

Pull Requests

Before submitting a Pull Request, ensure that:

  • If it is a bug fix make sure there is a corresponding issue first.
  • You have a good title.
  • The code builds successfully.
  • You have tested the feature and ensure it works as expected.
  • Documentation (README) has been updated if necessary.
  • The PR focuses on a single topic (do not address multiple unrelated things in one PR).
  • If not all of these things apply you may still already open a draft PR.

Please include:

  • A description of the changes
  • The motivation behind them
  • References to related issues

Code Review

All contributions are reviewed before being merged.

Code quality/security checks must pass.

Feedback is intended to improve the project and maintain quality. Please be open to discussion and revisions.

Everyone is welcome to review and provide feedback.

Community Guidelines

Please be respectful and constructive in all interactions.

Do not advertise your own apps/forks if they are not related to the topic in the thread you are posting.

Questions?

If you have questions, feel free to open an issue, comment in a discussion or create a new one.

Thank you for contributing ❤️