Skip to content

Commit a5204ea

Browse files
committed
Add contributing.md
1 parent e48e381 commit a5204ea

File tree

1 file changed

+82
-0
lines changed

1 file changed

+82
-0
lines changed

CONTRIBUTING.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Contributing to Pulse Editor 💡
2+
3+
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!
4+
5+
# How to Contribute 🛠
6+
7+
## Reporting Bugs
8+
9+
1. Search existing issues to avoid duplication.
10+
11+
2. Open a new issue with:
12+
13+
- A clear title
14+
15+
- Description of the bug
16+
17+
- Reproduction steps
18+
19+
- Expected vs actual behavior
20+
21+
- Your environment (platform, version, Node.js, etc.)
22+
23+
Feel free to label it with the issue type (e.g. bug, platform:desktop).
24+
25+
## Requesting Features
26+
27+
Open an issue with:
28+
29+
- A clear feature summary
30+
31+
- Use cases or why it's needed
32+
33+
- If possible, mockups or approach outlines
34+
35+
- Label it appropriately (e.g. enhancement, extension)
36+
37+
## Working on Code
38+
39+
1. Fork the repo and create a feature branch (fix/…, feat/…, etc.).
40+
41+
2. Install dependencies and set up your dev environment.
42+
43+
3. Write code, documentation, and tests.
44+
45+
## Opening a Pull Request
46+
47+
1. Target the main or beta branch as appropriate.
48+
49+
2. PR checklist:
50+
51+
- [ ] Includes meaningful title and description
52+
53+
- [ ] References issue (#1234)
54+
55+
- [ ] Includes tests or updated docs
56+
57+
- [ ] Follows code style and passes formatting/linting
58+
59+
3. CI must pass (lint, test, build).
60+
61+
4. Maintainers will review; you may be asked to make changes.
62+
63+
# Code Style & Testing 🔧
64+
65+
Use Prettier & ESLint — run npm run lint and npm run format.
66+
67+
# Communication Channels 💬
68+
69+
- [Issues on GitHub](https://github.com/claypulse/pulse-editor/issues) — bug reports, feature requests, discussion.
70+
71+
- [Discord](https://discord.com/invite/s6J54HFxQp) — for real-time support.
72+
73+
- [Marketplace Developer Program](https://pulse-editor.com/beta) — gain access to publish extensions
74+
75+
# Code of Conduct 🤝
76+
77+
This project is under a [Code of Conduct](/CODE_OF_CONDUCT.md).
78+
Please read it and respect others. Thanks for fostering a welcoming community!
79+
80+
# Acknowledgements 🎉
81+
82+
Thank you to all contributors! Your help in code, tests, docs, issue triage, and more helps make Pulse better every day!

0 commit comments

Comments
 (0)