Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (42 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

82 lines (42 loc) · 2.16 KB

Contributing to Pulse Editor 💡

Thank you for your interest in contributing to Pulse Editor! We’re building an AI‑powered, cross‑platform editor, and your help is invaluable—whether you're reporting bugs, requesting features, creating your own extensions, or improving docs or code. Let's build something amazing together!

How to Contribute 🛠

Reporting Bugs

  1. Search existing issues to avoid duplication.

  2. Open a new issue with:

    • A clear title

    • Description of the bug

    • Reproduction steps

    • Expected vs actual behavior

    • Your environment (platform, version, Node.js, etc.)

Feel free to label it with the issue type (e.g. bug, platform:desktop).

Requesting Features

Open an issue with:

  • A clear feature summary

  • Use cases or why it's needed

  • If possible, mockups or approach outlines

  • Label it appropriately (e.g. enhancement, extension)

Working on Code

  1. Fork the repo and create a feature branch (fix/…, feat/…, etc.).

  2. Install dependencies and set up your dev environment.

  3. Write code, documentation, and tests.

Opening a Pull Request

  1. Target the main or beta branch as appropriate.

  2. PR checklist:

    • Includes meaningful title and description

    • References issue (#1234)

    • Includes tests or updated docs

    • Follows code style and passes formatting/linting

  3. CI must pass (lint, test, build).

  4. Maintainers will review; you may be asked to make changes.

Code Style & Testing 🔧

Use Prettier & ESLint — run npm run lint and npm run format.

Communication Channels 💬

Code of Conduct 🤝

This project is under a Code of Conduct. Please read it and respect others. Thanks for fostering a welcoming community!

Acknowledgements 🎉

Thank you to all contributors! Your help in code, tests, docs, issue triage, and more helps make Pulse better every day!